~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-08-17 02:11:25 UTC
  • Revision ID: mbp@sourcefrog.net-20050817021125-178eae78b609dad8
- note for contributors to please update the NEWS file

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
 
1
# Copyright (C) 2005 Canonical Ltd
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
18
17
"""Tree classes, representing directory at point in time.
19
18
"""
20
19
 
21
 
from sets import Set
22
 
import os.path, os, fnmatch
23
 
 
24
 
from inventory import Inventory
25
 
from trace import mutter, note
26
 
from osutils import pumpfile, compare_files, filesize, quotefn, sha_file, \
27
 
     joinpath, splitpath, appendpath, isdir, isfile, file_kind
28
 
from errors import bailout
29
 
import branch
30
 
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
 
20
import os
31
21
 
32
22
import bzrlib
33
 
 
34
 
class Tree:
 
23
from bzrlib.trace import mutter, note
 
24
from bzrlib.errors import BzrError
 
25
from bzrlib.inventory import Inventory
 
26
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
 
27
 
 
28
 
 
29
exporters = {}
 
30
 
 
31
class Tree(object):
35
32
    """Abstract file tree.
36
33
 
37
34
    There are several subclasses:
60
57
    def has_id(self, file_id):
61
58
        return self.inventory.has_id(file_id)
62
59
 
63
 
    def id_set(self):
64
 
        """Return set of all ids in this tree."""
65
 
        return self.inventory.id_set()
 
60
    __contains__ = has_id
 
61
 
 
62
    def __iter__(self):
 
63
        return iter(self.inventory)
66
64
 
67
65
    def id2path(self, file_id):
68
66
        return self.inventory.id2path(file_id)
69
67
 
70
68
    def _get_inventory(self):
71
69
        return self._inventory
 
70
    
 
71
    def get_file_by_path(self, path):
 
72
        return self.get_file(self._inventory.path2id(path))
72
73
 
73
74
    inventory = property(_get_inventory,
74
75
                         doc="Inventory of this Tree")
75
76
 
76
77
    def _check_retrieved(self, ie, f):
77
 
        # TODO: Test this check by damaging the store?
78
 
        if ie.text_size is not None:
79
 
            fs = filesize(f)
80
 
            if fs != ie.text_size:
81
 
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
78
        fp = fingerprint_file(f)
 
79
        f.seek(0)
 
80
        
 
81
        if ie.text_size != None:
 
82
            if ie.text_size != fp['size']:
 
83
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
82
84
                        ["inventory expects %d bytes" % ie.text_size,
83
 
                         "file is actually %d bytes" % fs,
 
85
                         "file is actually %d bytes" % fp['size'],
84
86
                         "store is probably damaged/corrupt"])
85
87
 
86
 
        f_hash = sha_file(f)
87
 
        f.seek(0)
88
 
        if ie.text_sha1 != f_hash:
89
 
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
88
        if ie.text_sha1 != fp['sha1']:
 
89
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
90
90
                    ["inventory expects %s" % ie.text_sha1,
91
 
                     "file is actually %s" % f_hash,
 
91
                     "file is actually %s" % fp['sha1'],
92
92
                     "store is probably damaged/corrupt"])
93
93
 
94
94
 
95
 
    def export(self, dest):
96
 
        """Export this tree to a new directory.
97
 
 
98
 
        `dest` should not exist, and will be created holding the
99
 
        contents of this tree.
100
 
 
101
 
        :todo: To handle subdirectories we need to create the
102
 
               directories first.
103
 
 
104
 
        :note: If the export fails, the destination directory will be
105
 
               left in a half-assed state.
106
 
        """
107
 
        os.mkdir(dest)
108
 
        mutter('export version %r' % self)
109
 
        inv = self.inventory
110
 
        for dp, ie in inv.iter_entries():
111
 
            kind = ie.kind
112
 
            fullpath = appendpath(dest, dp)
113
 
            if kind == 'directory':
114
 
                os.mkdir(fullpath)
115
 
            elif kind == 'file':
116
 
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
117
 
            else:
118
 
                bailout("don't know how to export {%s} of kind %r", fid, kind)
119
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
120
 
 
121
 
 
122
 
 
123
 
class WorkingTree(Tree):
124
 
    """Working copy tree.
125
 
 
126
 
    The inventory is held in the `Branch` working-inventory, and the
127
 
    files are in a directory on disk.
128
 
 
129
 
    It is possible for a `WorkingTree` to have a filename which is
130
 
    not listed in the Inventory and vice versa.
131
 
    """
132
 
    def __init__(self, basedir, inv):
133
 
        self._inventory = inv
134
 
        self.basedir = basedir
135
 
        self.path2id = inv.path2id
136
 
 
137
 
    def __repr__(self):
138
 
        return "<%s of %s>" % (self.__class__.__name__,
139
 
                               self.basedir)
140
 
 
141
 
    def _rel(self, filename):
142
 
        return os.path.join(self.basedir, filename)
143
 
 
144
 
    def has_filename(self, filename):
145
 
        return os.path.exists(self._rel(filename))
146
 
 
147
 
    def get_file(self, file_id):
148
 
        return self.get_file_byname(self.id2path(file_id))
149
 
 
150
 
    def get_file_byname(self, filename):
151
 
        return file(self._rel(filename), 'rb')
152
 
 
153
 
    def _get_store_filename(self, file_id):
154
 
        return self._rel(self.id2path(file_id))
155
 
 
156
 
    def has_id(self, file_id):
157
 
        # files that have been deleted are excluded
158
 
        if not self.inventory.has_id(file_id):
159
 
            return False
160
 
        return os.access(self._rel(self.inventory.id2path(file_id)), os.F_OK)
161
 
 
162
 
    def get_file_size(self, file_id):
163
 
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
164
 
 
165
 
    def get_file_sha1(self, file_id):
166
 
        f = self.get_file(file_id)
167
 
        return sha_file(f)
168
 
 
169
 
 
170
 
    def file_class(self, filename):
171
 
        if self.path2id(filename):
172
 
            return 'V'
173
 
        elif self.is_ignored(filename):
174
 
            return 'I'
175
 
        else:
176
 
            return '?'
177
 
 
178
 
 
179
 
    def file_kind(self, filename):
180
 
        if isfile(self._rel(filename)):
181
 
            return 'file'
182
 
        elif isdir(self._rel(filename)):
183
 
            return 'directory'
184
 
        else:
185
 
            return 'unknown'
186
 
 
187
 
 
188
 
    def list_files(self):
189
 
        """Recursively list all files as (path, class, kind, id).
190
 
 
191
 
        Lists, but does not descend into unversioned directories.
192
 
 
193
 
        This does not include files that have been deleted in this
194
 
        tree.
195
 
 
196
 
        Skips the control directory.
197
 
        """
198
 
        inv = self.inventory
199
 
 
200
 
        def descend(from_dir, from_dir_id, dp):
201
 
            ls = os.listdir(dp)
202
 
            ls.sort()
203
 
            for f in ls:
204
 
                if bzrlib.BZRDIR == f:
205
 
                    continue
206
 
 
207
 
                # path within tree
208
 
                fp = appendpath(from_dir, f)
209
 
 
210
 
                # absolute path
211
 
                fap = appendpath(dp, f)
212
 
                
213
 
                f_ie = inv.get_child(from_dir_id, f)
214
 
                if f_ie:
215
 
                    c = 'V'
216
 
                elif self.is_ignored(fp):
217
 
                    c = 'I'
218
 
                else:
219
 
                    c = '?'
220
 
 
221
 
                fk = file_kind(fap)
222
 
 
223
 
                if f_ie:
224
 
                    if f_ie.kind != fk:
225
 
                        bailout("file %r entered as kind %r id %r, now of kind %r"
226
 
                                % (fap, f_ie.kind, f_ie.file_id, fk))
227
 
 
228
 
                yield fp, c, fk, (f_ie and f_ie.file_id)
229
 
 
230
 
                if fk != 'directory':
231
 
                    continue
232
 
 
233
 
                if c != 'V':
234
 
                    # don't descend unversioned directories
235
 
                    continue
236
 
                
237
 
                for ff in descend(fp, f_ie.file_id, fap):
238
 
                    yield ff
239
 
 
240
 
        for f in descend('', None, self.basedir):
241
 
            yield f
242
 
            
243
 
 
244
 
 
245
 
    def unknowns(self, path='', dir_id=None):
246
 
        """Yield names of unknown files in this WorkingTree.
247
 
 
248
 
        If there are any unknown directories then only the directory is
249
 
        returned, not all its children.  But if there are unknown files
250
 
        under a versioned subdirectory, they are returned.
251
 
 
252
 
        Currently returned depth-first, sorted by name within directories.
253
 
        """
254
 
        for fpath, fclass, fkind, fid in self.list_files():
255
 
            if fclass == '?':
256
 
                yield fpath
257
 
                
258
 
 
259
 
    def ignored_files(self):
260
 
        for fpath, fclass, fkind, fid in self.list_files():
261
 
            if fclass == 'I':
262
 
                yield fpath
263
 
 
264
 
 
265
 
    def get_ignore_list(self):
266
 
        """Return list of ignore patterns."""
267
 
        if self.has_filename(bzrlib.IGNORE_FILENAME):
268
 
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
269
 
            return [line.rstrip("\n\r") for line in f.readlines()]
270
 
        else:
271
 
            return bzrlib.DEFAULT_IGNORE
272
 
 
273
 
 
274
 
    def is_ignored(self, filename):
275
 
        """Check whether the filename matches an ignore pattern.
276
 
 
277
 
        Patterns containing '/' need to match the whole path; others
278
 
        match against only the last component."""
279
 
        ## TODO: Take them from a file, not hardcoded
280
 
        ## TODO: Use extended zsh-style globs maybe?
281
 
        ## TODO: Use '**' to match directories?
282
 
        for pat in self.get_ignore_list():
283
 
            if '/' in pat:
284
 
                if fnmatch.fnmatchcase(filename, pat):
285
 
                    return True
286
 
            else:
287
 
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
288
 
                    return True
289
 
        return False
290
 
        
291
 
 
292
 
        
293
 
        
 
95
    def print_file(self, fileid):
 
96
        """Print file with id `fileid` to stdout."""
 
97
        import sys
 
98
        pumpfile(self.get_file(fileid), sys.stdout)
 
99
        
 
100
        
 
101
    def export(self, dest, format='dir', root=None):
 
102
        """Export this tree."""
 
103
        try:
 
104
            exporter = exporters[format]
 
105
        except KeyError:
 
106
            from bzrlib.errors import BzrCommandError
 
107
            raise BzrCommandError("export format %r not supported" % format)
 
108
        exporter(self, dest, root)
 
109
 
 
110
 
294
111
 
295
112
class RevisionTree(Tree):
296
113
    """Tree viewing a previous revision.
297
114
 
298
115
    File text can be retrieved from the text store.
299
116
 
300
 
    :todo: Some kind of `__repr__` method, but a good one
 
117
    TODO: Some kind of `__repr__` method, but a good one
301
118
           probably means knowing the branch and revision number,
302
119
           or at least passing a description to the constructor.
303
120
    """
310
127
        ie = self._inventory[file_id]
311
128
        f = self._store[ie.text_id]
312
129
        mutter("  get fileid{%s} from %r" % (file_id, self))
313
 
        fs = filesize(f)
314
 
        if ie.text_size is None:
315
 
            note("warning: no text size recorded on %r" % ie)
316
130
        self._check_retrieved(ie, f)
317
131
        return f
318
132
 
321
135
 
322
136
    def get_file_sha1(self, file_id):
323
137
        ie = self._inventory[file_id]
324
 
        return ie.text_sha1
 
138
        if ie.kind == "file":
 
139
            return ie.text_sha1
325
140
 
326
141
    def has_filename(self, filename):
327
142
        return bool(self.inventory.path2id(filename))
343
158
        if False:  # just to make it a generator
344
159
            yield None
345
160
    
 
161
    def __contains__(self, file_id):
 
162
        return file_id in self._inventory
 
163
 
346
164
 
347
165
 
348
166
######################################################################
400
218
 
401
219
    
402
220
 
 
221
def find_renames(old_inv, new_inv):
 
222
    for file_id in old_inv:
 
223
        if file_id not in new_inv:
 
224
            continue
 
225
        old_name = old_inv.id2path(file_id)
 
226
        new_name = new_inv.id2path(file_id)
 
227
        if old_name != new_name:
 
228
            yield (old_name, new_name)
 
229
            
 
230
 
 
231
 
 
232
######################################################################
 
233
# export
 
234
 
 
235
def dir_exporter(tree, dest, root):
 
236
    """Export this tree to a new directory.
 
237
 
 
238
    `dest` should not exist, and will be created holding the
 
239
    contents of this tree.
 
240
 
 
241
    TODO: To handle subdirectories we need to create the
 
242
           directories first.
 
243
 
 
244
    :note: If the export fails, the destination directory will be
 
245
           left in a half-assed state.
 
246
    """
 
247
    import os
 
248
    os.mkdir(dest)
 
249
    mutter('export version %r' % tree)
 
250
    inv = tree.inventory
 
251
    for dp, ie in inv.iter_entries():
 
252
        kind = ie.kind
 
253
        fullpath = appendpath(dest, dp)
 
254
        if kind == 'directory':
 
255
            os.mkdir(fullpath)
 
256
        elif kind == 'file':
 
257
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
 
258
        else:
 
259
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
 
260
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
261
exporters['dir'] = dir_exporter
 
262
 
 
263
try:
 
264
    import tarfile
 
265
except ImportError:
 
266
    pass
 
267
else:
 
268
    def get_root_name(dest):
 
269
        """Get just the root name for a tarball.
 
270
 
 
271
        >>> get_root_name('mytar.tar')
 
272
        'mytar'
 
273
        >>> get_root_name('mytar.tar.bz2')
 
274
        'mytar'
 
275
        >>> get_root_name('tar.tar.tar.tgz')
 
276
        'tar.tar.tar'
 
277
        >>> get_root_name('bzr-0.0.5.tar.gz')
 
278
        'bzr-0.0.5'
 
279
        >>> get_root_name('a/long/path/mytar.tgz')
 
280
        'mytar'
 
281
        >>> get_root_name('../parent/../dir/other.tbz2')
 
282
        'other'
 
283
        """
 
284
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
 
285
        dest = os.path.basename(dest)
 
286
        for end in endings:
 
287
            if dest.endswith(end):
 
288
                return dest[:-len(end)]
 
289
 
 
290
    def tar_exporter(tree, dest, root, compression=None):
 
291
        """Export this tree to a new tar file.
 
292
 
 
293
        `dest` will be created holding the contents of this tree; if it
 
294
        already exists, it will be clobbered, like with "tar -c".
 
295
        """
 
296
        from time import time
 
297
        now = time()
 
298
        compression = str(compression or '')
 
299
        if root is None:
 
300
            root = get_root_name(dest)
 
301
        try:
 
302
            ball = tarfile.open(dest, 'w:' + compression)
 
303
        except tarfile.CompressionError, e:
 
304
            raise BzrError(str(e))
 
305
        mutter('export version %r' % tree)
 
306
        inv = tree.inventory
 
307
        for dp, ie in inv.iter_entries():
 
308
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
 
309
            item = tarfile.TarInfo(os.path.join(root, dp))
 
310
            # TODO: would be cool to actually set it to the timestamp of the
 
311
            # revision it was last changed
 
312
            item.mtime = now
 
313
            if ie.kind == 'directory':
 
314
                item.type = tarfile.DIRTYPE
 
315
                fileobj = None
 
316
                item.name += '/'
 
317
                item.size = 0
 
318
                item.mode = 0755
 
319
            elif ie.kind == 'file':
 
320
                item.type = tarfile.REGTYPE
 
321
                fileobj = tree.get_file(ie.file_id)
 
322
                item.size = _find_file_size(fileobj)
 
323
                item.mode = 0644
 
324
            else:
 
325
                raise BzrError("don't know how to export {%s} of kind %r" %
 
326
                        (ie.file_id, ie.kind))
 
327
 
 
328
            ball.addfile(item, fileobj)
 
329
        ball.close()
 
330
    exporters['tar'] = tar_exporter
 
331
 
 
332
    def tgz_exporter(tree, dest, root):
 
333
        tar_exporter(tree, dest, root, compression='gz')
 
334
    exporters['tgz'] = tgz_exporter
 
335
 
 
336
    def tbz_exporter(tree, dest, root):
 
337
        tar_exporter(tree, dest, root, compression='bz2')
 
338
    exporters['tbz2'] = tbz_exporter
 
339
 
 
340
 
 
341
def _find_file_size(fileobj):
 
342
    offset = fileobj.tell()
 
343
    try:
 
344
        fileobj.seek(0, 2)
 
345
        size = fileobj.tell()
 
346
    except TypeError:
 
347
        # gzip doesn't accept second argument to seek()
 
348
        fileobj.seek(0)
 
349
        size = 0
 
350
        while True:
 
351
            nread = len(fileobj.read())
 
352
            if nread == 0:
 
353
                break
 
354
            size += nread
 
355
    fileobj.seek(offset)
 
356
    return size