~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-07-12 15:13:59 UTC
  • mfrom: (1850.1.2 diff-6391)
  • Revision ID: pqm@pqm.ubuntu.com-20060712151359-b22a8c043fa52eb7
(jam) update help text for diff (bug #6391)

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
from cStringIO import StringIO
22
22
 
23
23
import bzrlib
24
 
from bzrlib.trace import mutter, note
25
24
from bzrlib.errors import BzrError, BzrCheckError
 
25
from bzrlib import errors
26
26
from bzrlib.inventory import Inventory
27
 
from bzrlib.osutils import appendpath, fingerprint_file
28
 
 
29
 
 
30
 
exporters = {}
 
27
from bzrlib.osutils import fingerprint_file
 
28
import bzrlib.revision
 
29
from bzrlib.trace import mutter, note
31
30
 
32
31
class Tree(object):
33
32
    """Abstract file tree.
51
50
    trees or versioned trees.
52
51
    """
53
52
    
 
53
    def conflicts(self):
 
54
        """Get a list of the conflicts in the tree.
 
55
 
 
56
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
57
        """
 
58
        return []
 
59
 
 
60
    def get_parent_ids(self):
 
61
        """Get the parent ids for this tree. 
 
62
 
 
63
        :return: a list of parent ids. [] is returned to indicate
 
64
        a tree with no parents.
 
65
        :raises: BzrError if the parents are not known.
 
66
        """
 
67
        raise NotImplementedError(self.get_parent_ids)
 
68
    
54
69
    def has_filename(self, filename):
55
70
        """True if the tree has given filename."""
56
71
        raise NotImplementedError()
58
73
    def has_id(self, file_id):
59
74
        return self.inventory.has_id(file_id)
60
75
 
 
76
    def has_or_had_id(self, file_id):
 
77
        if file_id == self.inventory.root.file_id:
 
78
            return True
 
79
        return self.inventory.has_id(file_id)
 
80
 
61
81
    __contains__ = has_id
62
82
 
63
83
    def __iter__(self):
66
86
    def id2path(self, file_id):
67
87
        return self.inventory.id2path(file_id)
68
88
 
 
89
    def kind(self, file_id):
 
90
        raise NotImplementedError("subclasses must implement kind")
 
91
 
69
92
    def _get_inventory(self):
70
93
        return self._inventory
71
94
    
99
122
        """Print file with id `file_id` to stdout."""
100
123
        import sys
101
124
        sys.stdout.write(self.get_file_text(file_id))
102
 
        
103
 
        
104
 
    def export(self, dest, format='dir', root=None):
105
 
        """Export this tree."""
106
 
        try:
107
 
            exporter = exporters[format]
108
 
        except KeyError:
109
 
            from bzrlib.errors import BzrCommandError
110
 
            raise BzrCommandError("export format %r not supported" % format)
111
 
        exporter(self, dest, root)
112
 
 
113
 
 
114
 
 
 
125
 
 
126
    def lock_read(self):
 
127
        pass
 
128
 
 
129
    def unknowns(self):
 
130
        """What files are present in this tree and unknown.
 
131
        
 
132
        :return: an iterator over the unknown files.
 
133
        """
 
134
        return iter([])
 
135
 
 
136
    def unlock(self):
 
137
        pass
 
138
 
 
139
    def filter_unversioned_files(self, paths):
 
140
        """Filter out paths that are not versioned.
 
141
 
 
142
        :return: set of paths.
 
143
        """
 
144
        # NB: we specifically *don't* call self.has_filename, because for
 
145
        # WorkingTrees that can indicate files that exist on disk but that 
 
146
        # are not versioned.
 
147
        pred = self.inventory.has_filename
 
148
        return set((p for p in paths if not pred(p)))
 
149
        
 
150
        
115
151
class RevisionTree(Tree):
116
152
    """Tree viewing a previous revision.
117
153
 
122
158
           or at least passing a description to the constructor.
123
159
    """
124
160
    
125
 
    def __init__(self, weave_store, inv, revision_id):
126
 
        self._weave_store = weave_store
 
161
    def __init__(self, branch, inv, revision_id):
 
162
        # for compatability the 'branch' parameter has not been renamed to 
 
163
        # repository at this point. However, we should change RevisionTree's
 
164
        # construction to always be via Repository and not via direct 
 
165
        # construction - this will mean that we can change the constructor
 
166
        # with much less chance of breaking client code.
 
167
        self._repository = branch
 
168
        self._weave_store = branch.weave_store
127
169
        self._inventory = inv
128
170
        self._revision_id = revision_id
129
171
 
 
172
    def get_parent_ids(self):
 
173
        """See Tree.get_parent_ids.
 
174
 
 
175
        A RevisionTree's parents match the revision graph.
 
176
        """
 
177
        parent_ids = self._repository.get_revision(self._revision_id).parent_ids
 
178
        return parent_ids
 
179
        
 
180
    def get_revision_id(self):
 
181
        """Return the revision id associated with this tree."""
 
182
        return self._revision_id
 
183
 
130
184
    def get_weave(self, file_id):
131
 
        return self._weave_store.get_weave(file_id)
132
 
 
 
185
        return self._weave_store.get_weave(file_id,
 
186
                self._repository.get_transaction())
133
187
 
134
188
    def get_file_lines(self, file_id):
135
189
        ie = self._inventory[file_id]
136
190
        weave = self.get_weave(file_id)
137
 
        return weave.get(ie.revision)
138
 
        
 
191
        return weave.get_lines(ie.revision)
139
192
 
140
193
    def get_file_text(self, file_id):
141
194
        return ''.join(self.get_file_lines(file_id))
142
195
 
143
 
 
144
196
    def get_file(self, file_id):
145
197
        return StringIO(self.get_file_text(file_id))
146
198
 
147
199
    def get_file_size(self, file_id):
148
200
        return self._inventory[file_id].text_size
149
201
 
150
 
    def get_file_sha1(self, file_id):
 
202
    def get_file_sha1(self, file_id, path=None):
151
203
        ie = self._inventory[file_id]
152
204
        if ie.kind == "file":
153
205
            return ie.text_sha1
154
 
 
155
 
    def is_executable(self, file_id):
 
206
        return None
 
207
 
 
208
    def get_file_mtime(self, file_id, path=None):
 
209
        ie = self._inventory[file_id]
 
210
        revision = self._repository.get_revision(ie.revision)
 
211
        return revision.timestamp
 
212
 
 
213
    def is_executable(self, file_id, path=None):
 
214
        ie = self._inventory[file_id]
 
215
        if ie.kind != "file":
 
216
            return None 
156
217
        return self._inventory[file_id].executable
157
218
 
158
219
    def has_filename(self, filename):
167
228
        ie = self._inventory[file_id]
168
229
        return ie.symlink_target;
169
230
 
 
231
    def kind(self, file_id):
 
232
        return self._inventory[file_id].kind
 
233
 
 
234
    def lock_read(self):
 
235
        self._repository.lock_read()
 
236
 
 
237
    def unlock(self):
 
238
        self._repository.unlock()
 
239
 
170
240
 
171
241
class EmptyTree(Tree):
 
242
 
172
243
    def __init__(self):
173
244
        self._inventory = Inventory()
174
245
 
 
246
    def get_parent_ids(self):
 
247
        """See Tree.get_parent_ids.
 
248
 
 
249
        An EmptyTree always has NULL_REVISION as the only parent.
 
250
        """
 
251
        return []
 
252
 
175
253
    def get_symlink_target(self, file_id):
176
254
        return None
177
255
 
178
256
    def has_filename(self, filename):
179
257
        return False
180
258
 
 
259
    def kind(self, file_id):
 
260
        assert self._inventory[file_id].kind == "root_directory"
 
261
        return "root_directory"
 
262
 
181
263
    def list_files(self):
182
264
        return iter([])
183
265
    
184
266
    def __contains__(self, file_id):
185
267
        return file_id in self._inventory
186
268
 
187
 
    def get_file_sha1(self, file_id):
 
269
    def get_file_sha1(self, file_id, path=None):
188
270
        assert self._inventory[file_id].kind == "root_directory"
189
271
        return None
190
272
 
254
336
            yield (old_name, new_name)
255
337
            
256
338
 
257
 
 
258
 
######################################################################
259
 
# export
260
 
 
261
 
def dir_exporter(tree, dest, root):
262
 
    """Export this tree to a new directory.
263
 
 
264
 
    `dest` should not exist, and will be created holding the
265
 
    contents of this tree.
266
 
 
267
 
    TODO: To handle subdirectories we need to create the
268
 
           directories first.
269
 
 
270
 
    :note: If the export fails, the destination directory will be
271
 
           left in a half-assed state.
272
 
    """
273
 
    import os
274
 
    os.mkdir(dest)
275
 
    mutter('export version %r' % tree)
276
 
    inv = tree.inventory
277
 
    for dp, ie in inv.iter_entries():
278
 
        ie.put_on_disk(dest, dp, tree)
279
 
 
280
 
exporters['dir'] = dir_exporter
281
 
 
282
 
try:
283
 
    import tarfile
284
 
except ImportError:
285
 
    pass
286
 
else:
287
 
    def get_root_name(dest):
288
 
        """Get just the root name for a tarball.
289
 
 
290
 
        >>> get_root_name('mytar.tar')
291
 
        'mytar'
292
 
        >>> get_root_name('mytar.tar.bz2')
293
 
        'mytar'
294
 
        >>> get_root_name('tar.tar.tar.tgz')
295
 
        'tar.tar.tar'
296
 
        >>> get_root_name('bzr-0.0.5.tar.gz')
297
 
        'bzr-0.0.5'
298
 
        >>> get_root_name('a/long/path/mytar.tgz')
299
 
        'mytar'
300
 
        >>> get_root_name('../parent/../dir/other.tbz2')
301
 
        'other'
302
 
        """
303
 
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
304
 
        dest = os.path.basename(dest)
305
 
        for end in endings:
306
 
            if dest.endswith(end):
307
 
                return dest[:-len(end)]
308
 
 
309
 
    def tar_exporter(tree, dest, root, compression=None):
310
 
        """Export this tree to a new tar file.
311
 
 
312
 
        `dest` will be created holding the contents of this tree; if it
313
 
        already exists, it will be clobbered, like with "tar -c".
314
 
        """
315
 
        from time import time
316
 
        now = time()
317
 
        compression = str(compression or '')
318
 
        if root is None:
319
 
            root = get_root_name(dest)
320
 
        try:
321
 
            ball = tarfile.open(dest, 'w:' + compression)
322
 
        except tarfile.CompressionError, e:
323
 
            raise BzrError(str(e))
324
 
        mutter('export version %r' % tree)
325
 
        inv = tree.inventory
326
 
        for dp, ie in inv.iter_entries():
327
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
328
 
            item, fileobj = ie.get_tar_item(root, dp, now, tree)
329
 
            ball.addfile(item, fileobj)
330
 
        ball.close()
331
 
 
332
 
    exporters['tar'] = tar_exporter
333
 
 
334
 
    def tgz_exporter(tree, dest, root):
335
 
        tar_exporter(tree, dest, root, compression='gz')
336
 
    exporters['tgz'] = tgz_exporter
337
 
 
338
 
    def tbz_exporter(tree, dest, root):
339
 
        tar_exporter(tree, dest, root, compression='bz2')
340
 
    exporters['tbz2'] = tbz_exporter
 
339
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
340
    """Find the ids corresponding to specified filenames.
 
341
    
 
342
    All matches in all trees will be used, and all children of matched
 
343
    directories will be used.
 
344
 
 
345
    :param filenames: The filenames to find file_ids for
 
346
    :param trees: The trees to find file_ids within
 
347
    :param require_versioned: if true, all specified filenames must occur in
 
348
    at least one tree.
 
349
    :return: a set of file ids for the specified filenames and their children.
 
350
    """
 
351
    if not filenames:
 
352
        return None
 
353
    specified_ids = _find_filename_ids_across_trees(filenames, trees, 
 
354
                                                    require_versioned)
 
355
    return _find_children_across_trees(specified_ids, trees)
 
356
 
 
357
 
 
358
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
 
359
    """Find the ids corresponding to specified filenames.
 
360
    
 
361
    All matches in all trees will be used.
 
362
 
 
363
    :param filenames: The filenames to find file_ids for
 
364
    :param trees: The trees to find file_ids within
 
365
    :param require_versioned: if true, all specified filenames must occur in
 
366
    at least one tree.
 
367
    :return: a set of file ids for the specified filenames
 
368
    """
 
369
    not_versioned = []
 
370
    interesting_ids = set()
 
371
    for tree_path in filenames:
 
372
        not_found = True
 
373
        for tree in trees:
 
374
            file_id = tree.inventory.path2id(tree_path)
 
375
            if file_id is not None:
 
376
                interesting_ids.add(file_id)
 
377
                not_found = False
 
378
        if not_found:
 
379
            not_versioned.append(tree_path)
 
380
    if len(not_versioned) > 0 and require_versioned:
 
381
        raise errors.PathsNotVersionedError(not_versioned)
 
382
    return interesting_ids
 
383
 
 
384
 
 
385
def _find_children_across_trees(specified_ids, trees):
 
386
    """Return a set including specified ids and their children
 
387
    
 
388
    All matches in all trees will be used.
 
389
 
 
390
    :param trees: The trees to find file_ids within
 
391
    :return: a set containing all specified ids and their children 
 
392
    """
 
393
    interesting_ids = set(specified_ids)
 
394
    pending = interesting_ids
 
395
    # now handle children of interesting ids
 
396
    # we loop so that we handle all children of each id in both trees
 
397
    while len(pending) > 0:
 
398
        new_pending = set()
 
399
        for file_id in pending:
 
400
            for tree in trees:
 
401
                if file_id not in tree:
 
402
                    continue
 
403
                entry = tree.inventory[file_id]
 
404
                for child in getattr(entry, 'children', {}).itervalues():
 
405
                    if child.file_id not in interesting_ids:
 
406
                        new_pending.add(child.file_id)
 
407
        interesting_ids.update(new_pending)
 
408
        pending = new_pending
 
409
    return interesting_ids