~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-08-12 15:41:44 UTC
  • Revision ID: mbp@sourcefrog.net-20050812154144-bc98570a78b8f633
- merge in deferred revfile work

Show diffs side-by-side

added added

removed removed

Lines of Context:
18
18
"""
19
19
 
20
20
import os
21
 
from cStringIO import StringIO
22
21
 
23
22
import bzrlib
24
23
from bzrlib.trace import mutter, note
25
 
from bzrlib.errors import BzrError, BzrCheckError
 
24
from bzrlib.errors import BzrError
26
25
from bzrlib.inventory import Inventory
27
 
from bzrlib.osutils import appendpath, fingerprint_file
 
26
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
 
27
 
 
28
 
 
29
exporters = {}
28
30
 
29
31
class Tree(object):
30
32
    """Abstract file tree.
55
57
    def has_id(self, file_id):
56
58
        return self.inventory.has_id(file_id)
57
59
 
58
 
    def has_or_had_id(self, file_id):
59
 
        if file_id == self.inventory.root.file_id:
60
 
            return True
61
 
        return self.inventory.has_id(file_id)
62
 
 
63
60
    __contains__ = has_id
64
61
 
65
62
    def __iter__(self):
68
65
    def id2path(self, file_id):
69
66
        return self.inventory.id2path(file_id)
70
67
 
71
 
    def kind(self, file_id):
72
 
        raise NotImplementedError("subclasses must implement kind")
73
 
 
74
68
    def _get_inventory(self):
75
69
        return self._inventory
76
70
    
81
75
                         doc="Inventory of this Tree")
82
76
 
83
77
    def _check_retrieved(self, ie, f):
84
 
        if not __debug__:
85
 
            return  
86
78
        fp = fingerprint_file(f)
87
79
        f.seek(0)
88
80
        
100
92
                     "store is probably damaged/corrupt"])
101
93
 
102
94
 
103
 
    def print_file(self, file_id):
104
 
        """Print file with id `file_id` to stdout."""
 
95
    def print_file(self, fileid):
 
96
        """Print file with id `fileid` to stdout."""
105
97
        import sys
106
 
        sys.stdout.write(self.get_file_text(file_id))
107
 
 
108
 
    def lock_read(self):
109
 
        pass
110
 
 
111
 
    def unlock(self):
112
 
        pass
113
 
        
114
 
        
 
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
 
 
111
 
115
112
class RevisionTree(Tree):
116
113
    """Tree viewing a previous revision.
117
114
 
122
119
           or at least passing a description to the constructor.
123
120
    """
124
121
    
125
 
    def __init__(self, branch, inv, revision_id):
126
 
        self._branch = branch
127
 
        self._weave_store = branch.weave_store
 
122
    def __init__(self, store, inv):
 
123
        self._store = store
128
124
        self._inventory = inv
129
 
        self._revision_id = revision_id
130
 
 
131
 
    def get_weave(self, file_id):
132
 
        return self._weave_store.get_weave(file_id,
133
 
                self._branch.get_transaction())
134
 
 
135
 
    def get_file_lines(self, file_id):
136
 
        ie = self._inventory[file_id]
137
 
        weave = self.get_weave(file_id)
138
 
        return weave.get_lines(ie.revision)
139
 
 
140
 
    def get_file_text(self, file_id):
141
 
        return ''.join(self.get_file_lines(file_id))
142
125
 
143
126
    def get_file(self, file_id):
144
 
        return StringIO(self.get_file_text(file_id))
 
127
        ie = self._inventory[file_id]
 
128
        f = self._store[ie.text_id]
 
129
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
130
        self._check_retrieved(ie, f)
 
131
        return f
145
132
 
146
133
    def get_file_size(self, file_id):
147
134
        return self._inventory[file_id].text_size
151
138
        if ie.kind == "file":
152
139
            return ie.text_sha1
153
140
 
154
 
    def is_executable(self, file_id):
155
 
        ie = self._inventory[file_id]
156
 
        if ie.kind != "file":
157
 
            return None 
158
 
        return self._inventory[file_id].executable
159
 
 
160
141
    def has_filename(self, filename):
161
142
        return bool(self.inventory.path2id(filename))
162
143
 
163
144
    def list_files(self):
164
145
        # The only files returned by this are those from the version
165
146
        for path, entry in self.inventory.iter_entries():
166
 
            yield path, 'V', entry.kind, entry.file_id, entry
167
 
 
168
 
    def get_symlink_target(self, file_id):
169
 
        ie = self._inventory[file_id]
170
 
        return ie.symlink_target;
171
 
 
172
 
    def kind(self, file_id):
173
 
        return self._inventory[file_id].kind
174
 
 
175
 
    def lock_read(self):
176
 
        self._branch.lock_read()
177
 
 
178
 
    def unlock(self):
179
 
        self._branch.unlock()
 
147
            yield path, 'V', entry.kind, entry.file_id
180
148
 
181
149
 
182
150
class EmptyTree(Tree):
183
151
    def __init__(self):
184
152
        self._inventory = Inventory()
185
153
 
186
 
    def get_symlink_target(self, file_id):
187
 
        return None
188
 
 
189
154
    def has_filename(self, filename):
190
155
        return False
191
156
 
192
 
    def kind(self, file_id):
193
 
        assert self._inventory[file_id].kind == "root_directory"
194
 
        return "root_directory"
195
 
 
196
157
    def list_files(self):
197
 
        return iter([])
 
158
        if False:  # just to make it a generator
 
159
            yield None
198
160
    
199
161
    def __contains__(self, file_id):
200
162
        return file_id in self._inventory
201
163
 
202
 
    def get_file_sha1(self, file_id):
203
 
        assert self._inventory[file_id].kind == "root_directory"
204
 
        return None
205
164
 
206
165
 
207
166
######################################################################
270
229
            
271
230
 
272
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