~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Robert Collins
  • Date: 2006-03-28 11:16:28 UTC
  • mto: (1626.2.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1628.
  • Revision ID: robertc@robertcollins.net-20060328111628-47766b0fdfa443ab
Add MergeSort facility to bzrlib.tsort.

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
 
from sets import Set
21
 
import os.path, os, fnmatch, time
22
 
 
23
 
from osutils import pumpfile, filesize, quotefn, sha_file, \
24
 
     joinpath, splitpath, appendpath, isdir, isfile, file_kind, fingerprint_file
25
 
import errno
26
 
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
27
 
 
 
20
import os
 
21
from cStringIO import StringIO
 
22
 
 
23
import bzrlib
 
24
from bzrlib.trace import mutter, note
 
25
from bzrlib.errors import BzrError, BzrCheckError
28
26
from bzrlib.inventory import Inventory
29
 
from bzrlib.trace import mutter, note
30
 
from bzrlib.errors import BzrError
31
 
import branch
32
 
 
33
 
import bzrlib
34
 
 
35
 
exporters = {}
 
27
from bzrlib.osutils import appendpath, fingerprint_file
36
28
 
37
29
class Tree(object):
38
30
    """Abstract file tree.
63
55
    def has_id(self, file_id):
64
56
        return self.inventory.has_id(file_id)
65
57
 
 
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
 
66
63
    __contains__ = has_id
67
64
 
68
65
    def __iter__(self):
71
68
    def id2path(self, file_id):
72
69
        return self.inventory.id2path(file_id)
73
70
 
 
71
    def kind(self, file_id):
 
72
        raise NotImplementedError("subclasses must implement kind")
 
73
 
74
74
    def _get_inventory(self):
75
75
        return self._inventory
 
76
    
 
77
    def get_file_by_path(self, path):
 
78
        return self.get_file(self._inventory.path2id(path))
76
79
 
77
80
    inventory = property(_get_inventory,
78
81
                         doc="Inventory of this Tree")
79
82
 
80
83
    def _check_retrieved(self, ie, f):
 
84
        if not __debug__:
 
85
            return  
81
86
        fp = fingerprint_file(f)
82
87
        f.seek(0)
83
88
        
95
100
                     "store is probably damaged/corrupt"])
96
101
 
97
102
 
98
 
    def print_file(self, fileid):
99
 
        """Print file with id `fileid` to stdout."""
 
103
    def print_file(self, file_id):
 
104
        """Print file with id `file_id` to stdout."""
100
105
        import sys
101
 
        pumpfile(self.get_file(fileid), sys.stdout)
102
 
        
103
 
        
104
 
    def export(self, dest, format='dir'):
105
 
        """Export this tree."""
106
 
        try:
107
 
            exporter = exporters[format]
108
 
        except KeyError:
109
 
            raise BzrCommandError("export format %r not supported" % format)
110
 
        exporter(self, dest)
111
 
 
112
 
 
113
 
 
 
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
        
114
115
class RevisionTree(Tree):
115
116
    """Tree viewing a previous revision.
116
117
 
121
122
           or at least passing a description to the constructor.
122
123
    """
123
124
    
124
 
    def __init__(self, store, inv):
125
 
        self._store = store
 
125
    def __init__(self, branch, inv, revision_id):
 
126
        self._branch = branch
 
127
        self._weave_store = branch.weave_store
126
128
        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))
127
142
 
128
143
    def get_file(self, file_id):
129
 
        ie = self._inventory[file_id]
130
 
        f = self._store[ie.text_id]
131
 
        mutter("  get fileid{%s} from %r" % (file_id, self))
132
 
        self._check_retrieved(ie, f)
133
 
        return f
 
144
        return StringIO(self.get_file_text(file_id))
134
145
 
135
146
    def get_file_size(self, file_id):
136
147
        return self._inventory[file_id].text_size
137
148
 
138
149
    def get_file_sha1(self, file_id):
139
150
        ie = self._inventory[file_id]
140
 
        return ie.text_sha1
 
151
        if ie.kind == "file":
 
152
            return ie.text_sha1
 
153
 
 
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
141
159
 
142
160
    def has_filename(self, filename):
143
161
        return bool(self.inventory.path2id(filename))
145
163
    def list_files(self):
146
164
        # The only files returned by this are those from the version
147
165
        for path, entry in self.inventory.iter_entries():
148
 
            yield path, 'V', entry.kind, entry.file_id
 
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()
149
180
 
150
181
 
151
182
class EmptyTree(Tree):
152
183
    def __init__(self):
153
184
        self._inventory = Inventory()
154
185
 
 
186
    def get_symlink_target(self, file_id):
 
187
        return None
 
188
 
155
189
    def has_filename(self, filename):
156
190
        return False
157
191
 
 
192
    def kind(self, file_id):
 
193
        assert self._inventory[file_id].kind == "root_directory"
 
194
        return "root_directory"
 
195
 
158
196
    def list_files(self):
159
 
        if False:  # just to make it a generator
160
 
            yield None
 
197
        return iter([])
161
198
    
 
199
    def __contains__(self, file_id):
 
200
        return file_id in self._inventory
 
201
 
 
202
    def get_file_sha1(self, file_id):
 
203
        assert self._inventory[file_id].kind == "root_directory"
 
204
        return None
162
205
 
163
206
 
164
207
######################################################################
227
270
            
228
271
 
229
272
 
230
 
######################################################################
231
 
# export
232
 
 
233
 
def dir_exporter(tree, dest):
234
 
    """Export this tree to a new directory.
235
 
 
236
 
    `dest` should not exist, and will be created holding the
237
 
    contents of this tree.
238
 
 
239
 
    TODO: To handle subdirectories we need to create the
240
 
           directories first.
241
 
 
242
 
    :note: If the export fails, the destination directory will be
243
 
           left in a half-assed state.
244
 
    """
245
 
    os.mkdir(dest)
246
 
    mutter('export version %r' % tree)
247
 
    inv = tree.inventory
248
 
    for dp, ie in inv.iter_entries():
249
 
        kind = ie.kind
250
 
        fullpath = appendpath(dest, dp)
251
 
        if kind == 'directory':
252
 
            os.mkdir(fullpath)
253
 
        elif kind == 'file':
254
 
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
255
 
        else:
256
 
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
257
 
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
258
 
exporters['dir'] = dir_exporter
259
 
 
260
 
try:
261
 
    import tarfile
262
 
except ImportError:
263
 
    pass
264
 
else:
265
 
    def tar_exporter(tree, dest, compression=None):
266
 
        """Export this tree to a new tar file.
267
 
 
268
 
        `dest` will be created holding the contents of this tree; if it
269
 
        already exists, it will be clobbered, like with "tar -c".
270
 
        """
271
 
        now = time.time()
272
 
        compression = str(compression or '')
273
 
        try:
274
 
            ball = tarfile.open(dest, 'w:' + compression)
275
 
        except tarfile.CompressionError, e:
276
 
            raise BzrError(str(e))
277
 
        mutter('export version %r' % tree)
278
 
        inv = tree.inventory
279
 
        for dp, ie in inv.iter_entries():
280
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
281
 
            item = tarfile.TarInfo(dp)
282
 
            # TODO: would be cool to actually set it to the timestamp of the
283
 
            # revision it was last changed
284
 
            item.mtime = now
285
 
            if ie.kind == 'directory':
286
 
                item.type = tarfile.DIRTYPE
287
 
                fileobj = None
288
 
                item.name += '/'
289
 
                item.size = 0
290
 
                item.mode = 0755
291
 
            elif ie.kind == 'file':
292
 
                item.type = tarfile.REGTYPE
293
 
                fileobj = tree.get_file(ie.file_id)
294
 
                item.size = _find_file_size(fileobj)
295
 
                item.mode = 0644
296
 
            else:
297
 
                raise BzrError("don't know how to export {%s} of kind %r" %
298
 
                        (ie.file_id, ie.kind))
299
 
 
300
 
            ball.addfile(item, fileobj)
301
 
        ball.close()
302
 
    exporters['tar'] = tar_exporter
303
 
 
304
 
    def tgz_exporter(tree, dest):
305
 
        tar_exporter(tree, dest, compression='gz')
306
 
    exporters['tgz'] = tgz_exporter
307
 
 
308
 
    def tbz_exporter(tree, dest):
309
 
        tar_exporter(tree, dest, compression='bz2')
310
 
    exporters['tbz2'] = tbz_exporter
311
 
 
312
 
 
313
 
def _find_file_size(fileobj):
314
 
    offset = fileobj.tell()
315
 
    try:
316
 
        fileobj.seek(0, 2)
317
 
        size = fileobj.tell()
318
 
    except TypeError:
319
 
        # gzip doesn't accept second argument to seek()
320
 
        fileobj.seek(0)
321
 
        size = 0
322
 
        while True:
323
 
            nread = len(fileobj.read())
324
 
            if nread == 0:
325
 
                break
326
 
            size += nread
327
 
    fileobj.seek(offset)
328
 
    return size