~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: 2007-11-03 23:02:16 UTC
  • mfrom: (2951.1.1 pack)
  • Revision ID: pqm@pqm.ubuntu.com-20071103230216-mnmwuxm413lyhjdv
(robertc) Fix data-refresh logic for packs not to refresh mid-transaction when a names write lock is held. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
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
22
 
 
23
 
from osutils import pumpfile, compare_files, 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
 
 
28
 
from inventory import Inventory
29
 
from trace import mutter, note
30
 
from errors import bailout
31
 
import branch
 
20
import os
 
21
from collections import deque
 
22
from cStringIO import StringIO
32
23
 
33
24
import bzrlib
34
 
 
35
 
class Tree:
 
25
from bzrlib import (
 
26
    delta,
 
27
    osutils,
 
28
    revision as _mod_revision,
 
29
    conflicts as _mod_conflicts,
 
30
    symbol_versioning,
 
31
    )
 
32
from bzrlib.decorators import needs_read_lock
 
33
from bzrlib.errors import BzrError, BzrCheckError
 
34
from bzrlib import errors
 
35
from bzrlib.inventory import Inventory, InventoryFile
 
36
from bzrlib.inter import InterObject
 
37
from bzrlib.osutils import fingerprint_file
 
38
import bzrlib.revision
 
39
from bzrlib.trace import mutter, note
 
40
 
 
41
 
 
42
class Tree(object):
36
43
    """Abstract file tree.
37
44
 
38
45
    There are several subclasses:
41
48
 
42
49
    * `RevisionTree` is a tree as recorded at some point in the past.
43
50
 
44
 
    * `EmptyTree`
45
 
 
46
51
    Trees contain an `Inventory` object, and also know how to retrieve
47
52
    file texts mentioned in the inventory, either from a working
48
53
    directory or from a store.
54
59
    trees or versioned trees.
55
60
    """
56
61
    
 
62
    def changes_from(self, other, want_unchanged=False, specific_files=None,
 
63
        extra_trees=None, require_versioned=False, include_root=False,
 
64
        want_unversioned=False):
 
65
        """Return a TreeDelta of the changes from other to this tree.
 
66
 
 
67
        :param other: A tree to compare with.
 
68
        :param specific_files: An optional list of file paths to restrict the
 
69
            comparison to. When mapping filenames to ids, all matches in all
 
70
            trees (including optional extra_trees) are used, and all children of
 
71
            matched directories are included.
 
72
        :param want_unchanged: An optional boolean requesting the inclusion of
 
73
            unchanged entries in the result.
 
74
        :param extra_trees: An optional list of additional trees to use when
 
75
            mapping the contents of specific_files (paths) to file_ids.
 
76
        :param require_versioned: An optional boolean (defaults to False). When
 
77
            supplied and True all the 'specific_files' must be versioned, or
 
78
            a PathsNotVersionedError will be thrown.
 
79
        :param want_unversioned: Scan for unversioned paths.
 
80
 
 
81
        The comparison will be performed by an InterTree object looked up on 
 
82
        self and other.
 
83
        """
 
84
        # Martin observes that Tree.changes_from returns a TreeDelta and this
 
85
        # may confuse people, because the class name of the returned object is
 
86
        # a synonym of the object referenced in the method name.
 
87
        return InterTree.get(other, self).compare(
 
88
            want_unchanged=want_unchanged,
 
89
            specific_files=specific_files,
 
90
            extra_trees=extra_trees,
 
91
            require_versioned=require_versioned,
 
92
            include_root=include_root,
 
93
            want_unversioned=want_unversioned,
 
94
            )
 
95
 
 
96
    def _iter_changes(self, from_tree, include_unchanged=False,
 
97
                     specific_files=None, pb=None, extra_trees=None,
 
98
                     require_versioned=True, want_unversioned=False):
 
99
        intertree = InterTree.get(from_tree, self)
 
100
        return intertree._iter_changes(include_unchanged, specific_files, pb,
 
101
            extra_trees, require_versioned, want_unversioned=want_unversioned)
 
102
    
 
103
    def conflicts(self):
 
104
        """Get a list of the conflicts in the tree.
 
105
 
 
106
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
107
        """
 
108
        return _mod_conflicts.ConflictList()
 
109
 
 
110
    def extras(self):
 
111
        """For trees that can have unversioned files, return all such paths."""
 
112
        return []
 
113
 
 
114
    def get_parent_ids(self):
 
115
        """Get the parent ids for this tree. 
 
116
 
 
117
        :return: a list of parent ids. [] is returned to indicate
 
118
        a tree with no parents.
 
119
        :raises: BzrError if the parents are not known.
 
120
        """
 
121
        raise NotImplementedError(self.get_parent_ids)
 
122
    
57
123
    def has_filename(self, filename):
58
124
        """True if the tree has given filename."""
59
 
        raise NotImplementedError()
 
125
        raise NotImplementedError(self.has_filename)
60
126
 
61
127
    def has_id(self, file_id):
62
128
        return self.inventory.has_id(file_id)
63
129
 
64
 
    def id_set(self):
65
 
        """Return set of all ids in this tree."""
66
 
        return self.inventory.id_set()
 
130
    __contains__ = has_id
 
131
 
 
132
    def has_or_had_id(self, file_id):
 
133
        if file_id == self.inventory.root.file_id:
 
134
            return True
 
135
        return self.inventory.has_id(file_id)
 
136
 
 
137
    def is_ignored(self, filename):
 
138
        """Check whether the filename is ignored by this tree.
 
139
 
 
140
        :param filename: The relative filename within the tree.
 
141
        :return: True if the filename is ignored.
 
142
        """
 
143
        return False
 
144
 
 
145
    def __iter__(self):
 
146
        return iter(self.inventory)
67
147
 
68
148
    def id2path(self, file_id):
 
149
        """Return the path for a file id.
 
150
 
 
151
        :raises NoSuchId:
 
152
        """
69
153
        return self.inventory.id2path(file_id)
70
154
 
 
155
    def is_control_filename(self, filename):
 
156
        """True if filename is the name of a control file in this tree.
 
157
        
 
158
        :param filename: A filename within the tree. This is a relative path
 
159
        from the root of this tree.
 
160
 
 
161
        This is true IF and ONLY IF the filename is part of the meta data
 
162
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
163
        on disk will not be a control file for this tree.
 
164
        """
 
165
        return self.bzrdir.is_control_filename(filename)
 
166
 
 
167
    @needs_read_lock
 
168
    def iter_entries_by_dir(self, specific_file_ids=None):
 
169
        """Walk the tree in 'by_dir' order.
 
170
 
 
171
        This will yield each entry in the tree as a (path, entry) tuple. The
 
172
        order that they are yielded is: the contents of a directory are 
 
173
        preceeded by the parent of a directory, and all the contents of a 
 
174
        directory are grouped together.
 
175
        """
 
176
        return self.inventory.iter_entries_by_dir(
 
177
            specific_file_ids=specific_file_ids)
 
178
 
 
179
    def iter_references(self):
 
180
        for path, entry in self.iter_entries_by_dir():
 
181
            if entry.kind == 'tree-reference':
 
182
                yield path, entry.file_id
 
183
 
 
184
    def kind(self, file_id):
 
185
        raise NotImplementedError("Tree subclass %s must implement kind"
 
186
            % self.__class__.__name__)
 
187
 
 
188
    def path_content_summary(self, path):
 
189
        """Get a summary of the information about path.
 
190
        
 
191
        :param path: A relative path within the tree.
 
192
        :return: A tuple containing kind, size, exec, sha1-or-link.
 
193
            Kind is always present (see tree.kind()).
 
194
            size is present if kind is file, None otherwise.
 
195
            exec is None unless kind is file and the platform supports the 'x'
 
196
                bit.
 
197
            sha1-or-link is the link target if kind is symlink, or the sha1 if
 
198
                it can be obtained without reading the file.
 
199
        """
 
200
        raise NotImplementedError(self.path_content_summary)
 
201
 
 
202
    def get_reference_revision(self, file_id, path=None):
 
203
        raise NotImplementedError("Tree subclass %s must implement "
 
204
                                  "get_reference_revision"
 
205
            % self.__class__.__name__)
 
206
 
 
207
    def _comparison_data(self, entry, path):
 
208
        """Return a tuple of kind, executable, stat_value for a file.
 
209
 
 
210
        entry may be None if there is no inventory entry for the file, but
 
211
        path must always be supplied.
 
212
 
 
213
        kind is None if there is no file present (even if an inventory id is
 
214
        present).  executable is False for non-file entries.
 
215
        """
 
216
        raise NotImplementedError(self._comparison_data)
 
217
 
 
218
    def _file_size(self, entry, stat_value):
 
219
        raise NotImplementedError(self._file_size)
 
220
 
71
221
    def _get_inventory(self):
72
222
        return self._inventory
 
223
    
 
224
    def get_file(self, file_id, path=None):
 
225
        """Return a file object for the file file_id in the tree.
 
226
        
 
227
        If both file_id and path are defined, it is implementation defined as
 
228
        to which one is used.
 
229
        """
 
230
        raise NotImplementedError(self.get_file)
 
231
 
 
232
    def get_file_mtime(self, file_id, path=None):
 
233
        """Return the modification time for a file.
 
234
 
 
235
        :param file_id: The handle for this file.
 
236
        :param path: The path that this file can be found at.
 
237
            These must point to the same object.
 
238
        """
 
239
        raise NotImplementedError(self.get_file_mtime)
 
240
 
 
241
    def get_file_by_path(self, path):
 
242
        return self.get_file(self._inventory.path2id(path), path)
 
243
 
 
244
    def iter_files_bytes(self, desired_files):
 
245
        """Iterate through file contents.
 
246
 
 
247
        Files will not necessarily be returned in the order they occur in
 
248
        desired_files.  No specific order is guaranteed.
 
249
 
 
250
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
251
        value supplied by the caller as part of desired_files.  It should
 
252
        uniquely identify the file version in the caller's context.  (Examples:
 
253
        an index number or a TreeTransform trans_id.)
 
254
 
 
255
        bytes_iterator is an iterable of bytestrings for the file.  The
 
256
        kind of iterable and length of the bytestrings are unspecified, but for
 
257
        this implementation, it is a tuple containing a single bytestring with
 
258
        the complete text of the file.
 
259
 
 
260
        :param desired_files: a list of (file_id, identifier) pairs
 
261
        """
 
262
        for file_id, identifier in desired_files:
 
263
            # We wrap the string in a tuple so that we can return an iterable
 
264
            # of bytestrings.  (Technically, a bytestring is also an iterable
 
265
            # of bytestrings, but iterating through each character is not
 
266
            # performant.)
 
267
            cur_file = (self.get_file_text(file_id),)
 
268
            yield identifier, cur_file
 
269
 
 
270
    def get_symlink_target(self, file_id):
 
271
        """Get the target for a given file_id.
 
272
 
 
273
        It is assumed that the caller already knows that file_id is referencing
 
274
        a symlink.
 
275
        :param file_id: Handle for the symlink entry.
 
276
        :return: The path the symlink points to.
 
277
        """
 
278
        raise NotImplementedError(self.get_symlink_target)
 
279
 
 
280
    def annotate_iter(self, file_id):
 
281
        """Return an iterator of revision_id, line tuples.
 
282
 
 
283
        For working trees (and mutable trees in general), the special
 
284
        revision_id 'current:' will be used for lines that are new in this
 
285
        tree, e.g. uncommitted changes.
 
286
        :param file_id: The file to produce an annotated version from
 
287
        """
 
288
        raise NotImplementedError(self.annotate_iter)
 
289
 
 
290
    def plan_file_merge(self, file_id, other):
 
291
        """Generate a merge plan based on annotations.
 
292
 
 
293
        If the file contains uncommitted changes in this tree, they will be
 
294
        attributed to the 'current:' pseudo-revision.  If the file contains
 
295
        uncommitted changes in the other tree, they will be assigned to the
 
296
        'other:' pseudo-revision.
 
297
        """
 
298
        from bzrlib import merge
 
299
        annotated_a = list(self.annotate_iter(file_id,
 
300
                                              _mod_revision.CURRENT_REVISION))
 
301
        annotated_b = list(other.annotate_iter(file_id, 'other:'))
 
302
        ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
 
303
        ancestors_b = other._get_ancestors('other:')
 
304
        return merge._plan_annotate_merge(annotated_a, annotated_b,
 
305
                                          ancestors_a, ancestors_b)
73
306
 
74
307
    inventory = property(_get_inventory,
75
308
                         doc="Inventory of this Tree")
76
309
 
77
310
    def _check_retrieved(self, ie, f):
 
311
        if not __debug__:
 
312
            return  
78
313
        fp = fingerprint_file(f)
79
314
        f.seek(0)
80
315
        
81
 
        if ie.text_size != None:
 
316
        if ie.text_size is not None:
82
317
            if ie.text_size != fp['size']:
83
 
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
318
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
84
319
                        ["inventory expects %d bytes" % ie.text_size,
85
320
                         "file is actually %d bytes" % fp['size'],
86
321
                         "store is probably damaged/corrupt"])
87
322
 
88
323
        if ie.text_sha1 != fp['sha1']:
89
 
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
324
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
90
325
                    ["inventory expects %s" % ie.text_sha1,
91
326
                     "file is actually %s" % fp['sha1'],
92
327
                     "store is probably damaged/corrupt"])
93
328
 
94
 
 
95
 
    def print_file(self, fileid):
96
 
        """Print file with id `fileid` to stdout."""
 
329
    @needs_read_lock
 
330
    def path2id(self, path):
 
331
        """Return the id for path in this tree."""
 
332
        return self._inventory.path2id(path)
 
333
 
 
334
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
335
        """Return all the ids that can be reached by walking from paths.
 
336
        
 
337
        Each path is looked up in this tree and any extras provided in
 
338
        trees, and this is repeated recursively: the children in an extra tree
 
339
        of a directory that has been renamed under a provided path in this tree
 
340
        are all returned, even if none exist under a provided path in this
 
341
        tree, and vice versa.
 
342
 
 
343
        :param paths: An iterable of paths to start converting to ids from.
 
344
            Alternatively, if paths is None, no ids should be calculated and None
 
345
            will be returned. This is offered to make calling the api unconditional
 
346
            for code that *might* take a list of files.
 
347
        :param trees: Additional trees to consider.
 
348
        :param require_versioned: If False, do not raise NotVersionedError if
 
349
            an element of paths is not versioned in this tree and all of trees.
 
350
        """
 
351
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
352
 
 
353
    def print_file(self, file_id):
 
354
        """Print file with id `file_id` to stdout."""
97
355
        import sys
98
 
        pumpfile(self.get_file(fileid), sys.stdout)
99
 
        
100
 
        
101
 
    def export(self, dest):        
102
 
        """Export this tree to a new directory.
103
 
 
104
 
        `dest` should not exist, and will be created holding the
105
 
        contents of this tree.
106
 
 
107
 
        TODO: To handle subdirectories we need to create the
108
 
               directories first.
109
 
 
110
 
        :note: If the export fails, the destination directory will be
111
 
               left in a half-assed state.
112
 
        """
113
 
        os.mkdir(dest)
114
 
        mutter('export version %r' % self)
115
 
        inv = self.inventory
116
 
        for dp, ie in inv.iter_entries():
117
 
            kind = ie.kind
118
 
            fullpath = appendpath(dest, dp)
119
 
            if kind == 'directory':
120
 
                os.mkdir(fullpath)
121
 
            elif kind == 'file':
122
 
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
123
 
            else:
124
 
                bailout("don't know how to export {%s} of kind %r" % (fid, kind))
125
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
126
 
 
127
 
 
128
 
 
129
 
class WorkingTree(Tree):
130
 
    """Working copy tree.
131
 
 
132
 
    The inventory is held in the `Branch` working-inventory, and the
133
 
    files are in a directory on disk.
134
 
 
135
 
    It is possible for a `WorkingTree` to have a filename which is
136
 
    not listed in the Inventory and vice versa.
137
 
    """
138
 
    def __init__(self, basedir, inv):
139
 
        self._inventory = inv
140
 
        self.basedir = basedir
141
 
        self.path2id = inv.path2id
142
 
 
143
 
    def __repr__(self):
144
 
        return "<%s of %s>" % (self.__class__.__name__,
145
 
                               self.basedir)
146
 
 
147
 
    def abspath(self, filename):
148
 
        return os.path.join(self.basedir, filename)
149
 
 
150
 
    def has_filename(self, filename):
151
 
        return os.path.exists(self.abspath(filename))
152
 
 
153
 
    def get_file(self, file_id):
154
 
        return self.get_file_byname(self.id2path(file_id))
155
 
 
156
 
    def get_file_byname(self, filename):
157
 
        return file(self.abspath(filename), 'rb')
158
 
 
159
 
    def _get_store_filename(self, file_id):
160
 
        ## XXX: badly named; this isn't in the store at all
161
 
        return self.abspath(self.id2path(file_id))
162
 
 
163
 
    def has_id(self, file_id):
164
 
        # files that have been deleted are excluded
165
 
        if not self.inventory.has_id(file_id):
166
 
            return False
167
 
        return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
168
 
 
169
 
    def get_file_size(self, file_id):
170
 
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
171
 
 
172
 
    def get_file_sha1(self, file_id):
173
 
        f = self.get_file(file_id)
174
 
        return sha_file(f)
175
 
 
176
 
 
177
 
    def file_class(self, filename):
178
 
        if self.path2id(filename):
179
 
            return 'V'
180
 
        elif self.is_ignored(filename):
181
 
            return 'I'
182
 
        else:
183
 
            return '?'
184
 
 
185
 
 
186
 
    def list_files(self):
187
 
        """Recursively list all files as (path, class, kind, id).
188
 
 
189
 
        Lists, but does not descend into unversioned directories.
190
 
 
191
 
        This does not include files that have been deleted in this
192
 
        tree.
193
 
 
194
 
        Skips the control directory.
195
 
        """
196
 
        inv = self.inventory
197
 
 
198
 
        def descend(from_dir_relpath, from_dir_id, dp):
199
 
            ls = os.listdir(dp)
200
 
            ls.sort()
201
 
            for f in ls:
202
 
                ## TODO: If we find a subdirectory with its own .bzr
203
 
                ## directory, then that is a separate tree and we
204
 
                ## should exclude it.
205
 
                if bzrlib.BZRDIR == f:
206
 
                    continue
207
 
 
208
 
                # path within tree
209
 
                fp = appendpath(from_dir_relpath, f)
210
 
 
211
 
                # absolute path
212
 
                fap = appendpath(dp, f)
213
 
                
214
 
                f_ie = inv.get_child(from_dir_id, f)
215
 
                if f_ie:
216
 
                    c = 'V'
217
 
                elif self.is_ignored(fp):
218
 
                    c = 'I'
219
 
                else:
220
 
                    c = '?'
221
 
 
222
 
                fk = file_kind(fap)
223
 
 
224
 
                if f_ie:
225
 
                    if f_ie.kind != fk:
226
 
                        bailout("file %r entered as kind %r id %r, now of kind %r"
227
 
                                % (fap, f_ie.kind, f_ie.file_id, fk))
228
 
 
229
 
                yield fp, c, fk, (f_ie and f_ie.file_id)
230
 
 
231
 
                if fk != 'directory':
232
 
                    continue
233
 
 
234
 
                if c != 'V':
235
 
                    # don't descend unversioned directories
236
 
                    continue
237
 
                
238
 
                for ff in descend(fp, f_ie.file_id, fap):
239
 
                    yield ff
240
 
 
241
 
        for f in descend('', inv.root.file_id, self.basedir):
242
 
            yield f
243
 
            
244
 
 
 
356
        sys.stdout.write(self.get_file_text(file_id))
 
357
 
 
358
    def lock_read(self):
 
359
        pass
 
360
 
 
361
    def revision_tree(self, revision_id):
 
362
        """Obtain a revision tree for the revision revision_id.
 
363
 
 
364
        The intention of this method is to allow access to possibly cached
 
365
        tree data. Implementors of this method should raise NoSuchRevision if
 
366
        the tree is not locally available, even if they could obtain the 
 
367
        tree via a repository or some other means. Callers are responsible 
 
368
        for finding the ultimate source for a revision tree.
 
369
 
 
370
        :param revision_id: The revision_id of the requested tree.
 
371
        :return: A Tree.
 
372
        :raises: NoSuchRevision if the tree cannot be obtained.
 
373
        """
 
374
        raise errors.NoSuchRevisionInTree(self, revision_id)
245
375
 
246
376
    def unknowns(self):
247
 
        for subp in self.extras():
248
 
            if not self.is_ignored(subp):
249
 
                yield subp
250
 
 
251
 
 
252
 
    def extras(self):
253
 
        """Yield all unknown files in this WorkingTree.
254
 
 
255
 
        If there are any unknown directories then only the directory is
256
 
        returned, not all its children.  But if there are unknown files
257
 
        under a versioned subdirectory, they are returned.
258
 
 
259
 
        Currently returned depth-first, sorted by name within directories.
260
 
        """
261
 
        ## TODO: Work from given directory downwards
262
 
        
263
 
        for path, dir_entry in self.inventory.directories():
264
 
            mutter("search for unknowns in %r" % path)
265
 
            dirabs = self.abspath(path)
266
 
            if not isdir(dirabs):
267
 
                # e.g. directory deleted
268
 
                continue
269
 
 
270
 
            fl = []
271
 
            for subf in os.listdir(dirabs):
272
 
                if (subf != '.bzr'
273
 
                    and (subf not in dir_entry.children)):
274
 
                    fl.append(subf)
275
 
            
276
 
            fl.sort()
277
 
            for subf in fl:
278
 
                subp = appendpath(path, subf)
279
 
                yield subp
280
 
 
281
 
 
282
 
    def ignored_files(self):
283
 
        """Yield list of PATH, IGNORE_PATTERN"""
284
 
        for subp in self.extras():
285
 
            pat = self.is_ignored(subp)
286
 
            if pat != None:
287
 
                yield subp, pat
288
 
 
289
 
 
290
 
    def get_ignore_list(self):
291
 
        """Return list of ignore patterns.
292
 
 
293
 
        Cached in the Tree object after the first call.
294
 
        """
295
 
        if hasattr(self, '_ignorelist'):
296
 
            return self._ignorelist
297
 
 
298
 
        l = bzrlib.DEFAULT_IGNORE[:]
299
 
        if self.has_filename(bzrlib.IGNORE_FILENAME):
300
 
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
301
 
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
302
 
        self._ignorelist = l
303
 
        return l
304
 
 
305
 
 
306
 
    def is_ignored(self, filename):
307
 
        r"""Check whether the filename matches an ignore pattern.
308
 
 
309
 
        Patterns containing '/' or '\' need to match the whole path;
310
 
        others match against only the last component.
311
 
 
312
 
        If the file is ignored, returns the pattern which caused it to
313
 
        be ignored, otherwise None.  So this can simply be used as a
314
 
        boolean if desired."""
315
 
 
316
 
        # TODO: Use '**' to match directories, and other extended
317
 
        # globbing stuff from cvs/rsync.
318
 
 
319
 
        # XXX: fnmatch is actually not quite what we want: it's only
320
 
        # approximately the same as real Unix fnmatch, and doesn't
321
 
        # treat dotfiles correctly and allows * to match /.
322
 
        # Eventually it should be replaced with something more
323
 
        # accurate.
324
 
        
325
 
        for pat in self.get_ignore_list():
326
 
            if '/' in pat or '\\' in pat:
327
 
                
328
 
                # as a special case, you can put ./ at the start of a
329
 
                # pattern; this is good to match in the top-level
330
 
                # only;
331
 
                
332
 
                if (pat[:2] == './') or (pat[:2] == '.\\'):
333
 
                    newpat = pat[2:]
334
 
                else:
335
 
                    newpat = pat
336
 
                if fnmatch.fnmatchcase(filename, newpat):
337
 
                    return pat
338
 
            else:
339
 
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
340
 
                    return pat
341
 
        return None
342
 
        
343
 
 
344
 
        
345
 
        
346
 
 
347
 
class RevisionTree(Tree):
348
 
    """Tree viewing a previous revision.
349
 
 
350
 
    File text can be retrieved from the text store.
351
 
 
352
 
    TODO: Some kind of `__repr__` method, but a good one
353
 
           probably means knowing the branch and revision number,
354
 
           or at least passing a description to the constructor.
355
 
    """
356
 
    
357
 
    def __init__(self, store, inv):
358
 
        self._store = store
359
 
        self._inventory = inv
360
 
 
361
 
    def get_file(self, file_id):
362
 
        ie = self._inventory[file_id]
363
 
        f = self._store[ie.text_id]
364
 
        mutter("  get fileid{%s} from %r" % (file_id, self))
365
 
        self._check_retrieved(ie, f)
366
 
        return f
367
 
 
368
 
    def get_file_size(self, file_id):
369
 
        return self._inventory[file_id].text_size
370
 
 
371
 
    def get_file_sha1(self, file_id):
372
 
        ie = self._inventory[file_id]
373
 
        return ie.text_sha1
374
 
 
375
 
    def has_filename(self, filename):
376
 
        return bool(self.inventory.path2id(filename))
377
 
 
378
 
    def list_files(self):
379
 
        # The only files returned by this are those from the version
380
 
        for path, entry in self.inventory.iter_entries():
381
 
            yield path, 'V', entry.kind, entry.file_id
 
377
        """What files are present in this tree and unknown.
 
378
        
 
379
        :return: an iterator over the unknown files.
 
380
        """
 
381
        return iter([])
 
382
 
 
383
    def unlock(self):
 
384
        pass
 
385
 
 
386
    def filter_unversioned_files(self, paths):
 
387
        """Filter out paths that are versioned.
 
388
 
 
389
        :return: set of paths.
 
390
        """
 
391
        # NB: we specifically *don't* call self.has_filename, because for
 
392
        # WorkingTrees that can indicate files that exist on disk but that 
 
393
        # are not versioned.
 
394
        pred = self.inventory.has_filename
 
395
        return set((p for p in paths if not pred(p)))
 
396
 
 
397
    def walkdirs(self, prefix=""):
 
398
        """Walk the contents of this tree from path down.
 
399
 
 
400
        This yields all the data about the contents of a directory at a time.
 
401
        After each directory has been yielded, if the caller has mutated the
 
402
        list to exclude some directories, they are then not descended into.
 
403
        
 
404
        The data yielded is of the form:
 
405
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
406
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
407
          versioned_kind), ...]),
 
408
         - directory-relpath is the containing dirs relpath from prefix
 
409
         - directory-path-from-root is the containing dirs path from /
 
410
         - directory-fileid is the id of the directory if it is versioned.
 
411
         - relpath is the relative path within the subtree being walked.
 
412
         - basename is the basename
 
413
         - kind is the kind of the file now. If unknonwn then the file is not
 
414
           present within the tree - but it may be recorded as versioned. See
 
415
           versioned_kind.
 
416
         - lstat is the stat data *if* the file was statted.
 
417
         - path_from_tree_root is the path from the root of the tree.
 
418
         - file_id is the file_id if the entry is versioned.
 
419
         - versioned_kind is the kind of the file as last recorded in the 
 
420
           versioning system. If 'unknown' the file is not versioned.
 
421
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
422
 
 
423
        :param prefix: Start walking from prefix within the tree rather than
 
424
        at the root. This allows one to walk a subtree but get paths that are
 
425
        relative to a tree rooted higher up.
 
426
        :return: an iterator over the directory data.
 
427
        """
 
428
        raise NotImplementedError(self.walkdirs)
382
429
 
383
430
 
384
431
class EmptyTree(Tree):
 
432
 
385
433
    def __init__(self):
386
 
        self._inventory = Inventory()
 
434
        self._inventory = Inventory(root_id=None)
 
435
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
436
                               ' use repository.revision_tree instead.',
 
437
                               DeprecationWarning, stacklevel=2)
 
438
 
 
439
    def get_parent_ids(self):
 
440
        return []
 
441
 
 
442
    def get_symlink_target(self, file_id):
 
443
        return None
387
444
 
388
445
    def has_filename(self, filename):
389
446
        return False
390
447
 
391
 
    def list_files(self):
392
 
        if False:  # just to make it a generator
393
 
            yield None
 
448
    def kind(self, file_id):
 
449
        assert self._inventory[file_id].kind == "directory"
 
450
        return "directory"
 
451
 
 
452
    def list_files(self, include_root=False):
 
453
        return iter([])
394
454
    
 
455
    def __contains__(self, file_id):
 
456
        return (file_id in self._inventory)
 
457
 
 
458
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
459
        return None
395
460
 
396
461
 
397
462
######################################################################
458
523
        if old_name != new_name:
459
524
            yield (old_name, new_name)
460
525
            
 
526
 
 
527
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
528
    """Find the ids corresponding to specified filenames.
 
529
    
 
530
    All matches in all trees will be used, and all children of matched
 
531
    directories will be used.
 
532
 
 
533
    :param filenames: The filenames to find file_ids for (if None, returns
 
534
        None)
 
535
    :param trees: The trees to find file_ids within
 
536
    :param require_versioned: if true, all specified filenames must occur in
 
537
    at least one tree.
 
538
    :return: a set of file ids for the specified filenames and their children.
 
539
    """
 
540
    if not filenames:
 
541
        return None
 
542
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
543
        require_versioned)
 
544
    return _find_children_across_trees(specified_path_ids, trees)
 
545
 
 
546
 
 
547
def _find_ids_across_trees(filenames, trees, require_versioned):
 
548
    """Find the ids corresponding to specified filenames.
 
549
    
 
550
    All matches in all trees will be used, but subdirectories are not scanned.
 
551
 
 
552
    :param filenames: The filenames to find file_ids for
 
553
    :param trees: The trees to find file_ids within
 
554
    :param require_versioned: if true, all specified filenames must occur in
 
555
        at least one tree.
 
556
    :return: a set of file ids for the specified filenames
 
557
    """
 
558
    not_versioned = []
 
559
    interesting_ids = set()
 
560
    for tree_path in filenames:
 
561
        not_found = True
 
562
        for tree in trees:
 
563
            file_id = tree.path2id(tree_path)
 
564
            if file_id is not None:
 
565
                interesting_ids.add(file_id)
 
566
                not_found = False
 
567
        if not_found:
 
568
            not_versioned.append(tree_path)
 
569
    if len(not_versioned) > 0 and require_versioned:
 
570
        raise errors.PathsNotVersionedError(not_versioned)
 
571
    return interesting_ids
 
572
 
 
573
 
 
574
def _find_children_across_trees(specified_ids, trees):
 
575
    """Return a set including specified ids and their children.
 
576
    
 
577
    All matches in all trees will be used.
 
578
 
 
579
    :param trees: The trees to find file_ids within
 
580
    :return: a set containing all specified ids and their children 
 
581
    """
 
582
    interesting_ids = set(specified_ids)
 
583
    pending = interesting_ids
 
584
    # now handle children of interesting ids
 
585
    # we loop so that we handle all children of each id in both trees
 
586
    while len(pending) > 0:
 
587
        new_pending = set()
 
588
        for file_id in pending:
 
589
            for tree in trees:
 
590
                if not tree.has_id(file_id):
 
591
                    continue
 
592
                entry = tree.inventory[file_id]
 
593
                for child in getattr(entry, 'children', {}).itervalues():
 
594
                    if child.file_id not in interesting_ids:
 
595
                        new_pending.add(child.file_id)
 
596
        interesting_ids.update(new_pending)
 
597
        pending = new_pending
 
598
    return interesting_ids
 
599
 
 
600
 
 
601
class InterTree(InterObject):
 
602
    """This class represents operations taking place between two Trees.
 
603
 
 
604
    Its instances have methods like 'compare' and contain references to the
 
605
    source and target trees these operations are to be carried out on.
 
606
 
 
607
    Clients of bzrlib should not need to use InterTree directly, rather they
 
608
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
609
    will pass through to InterTree as appropriate.
 
610
    """
 
611
 
 
612
    _optimisers = []
 
613
 
 
614
    @needs_read_lock
 
615
    def compare(self, want_unchanged=False, specific_files=None,
 
616
        extra_trees=None, require_versioned=False, include_root=False,
 
617
        want_unversioned=False):
 
618
        """Return the changes from source to target.
 
619
 
 
620
        :return: A TreeDelta.
 
621
        :param specific_files: An optional list of file paths to restrict the
 
622
            comparison to. When mapping filenames to ids, all matches in all
 
623
            trees (including optional extra_trees) are used, and all children of
 
624
            matched directories are included.
 
625
        :param want_unchanged: An optional boolean requesting the inclusion of
 
626
            unchanged entries in the result.
 
627
        :param extra_trees: An optional list of additional trees to use when
 
628
            mapping the contents of specific_files (paths) to file_ids.
 
629
        :param require_versioned: An optional boolean (defaults to False). When
 
630
            supplied and True all the 'specific_files' must be versioned, or
 
631
            a PathsNotVersionedError will be thrown.
 
632
        :param want_unversioned: Scan for unversioned paths.
 
633
        """
 
634
        # NB: show_status depends on being able to pass in non-versioned files
 
635
        # and report them as unknown
 
636
        trees = (self.source,)
 
637
        if extra_trees is not None:
 
638
            trees = trees + tuple(extra_trees)
 
639
        # target is usually the newer tree:
 
640
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
641
            require_versioned=require_versioned)
 
642
        if specific_files and not specific_file_ids:
 
643
            # All files are unversioned, so just return an empty delta
 
644
            # _compare_trees would think we want a complete delta
 
645
            result = delta.TreeDelta()
 
646
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
647
            result.unversioned = [(path, None,
 
648
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
649
                specific_files]
 
650
            return result
 
651
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
652
            specific_files, include_root, extra_trees=extra_trees,
 
653
            require_versioned=require_versioned,
 
654
            want_unversioned=want_unversioned)
 
655
 
 
656
    def _iter_changes(self, include_unchanged=False,
 
657
                      specific_files=None, pb=None, extra_trees=[],
 
658
                      require_versioned=True, want_unversioned=False):
 
659
        """Generate an iterator of changes between trees.
 
660
 
 
661
        A tuple is returned:
 
662
        (file_id, (path_in_source, path_in_target),
 
663
         changed_content, versioned, parent, name, kind,
 
664
         executable)
 
665
 
 
666
        Changed_content is True if the file's content has changed.  This
 
667
        includes changes to its kind, and to a symlink's target.
 
668
 
 
669
        versioned, parent, name, kind, executable are tuples of (from, to).
 
670
        If a file is missing in a tree, its kind is None.
 
671
 
 
672
        Iteration is done in parent-to-child order, relative to the target
 
673
        tree.
 
674
 
 
675
        There is no guarantee that all paths are in sorted order: the
 
676
        requirement to expand the search due to renames may result in children
 
677
        that should be found early being found late in the search, after
 
678
        lexically later results have been returned.
 
679
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
680
            path in the specific_files list is not versioned in one of
 
681
            source, target or extra_trees.
 
682
        :param want_unversioned: Should unversioned files be returned in the
 
683
            output. An unversioned file is defined as one with (False, False)
 
684
            for the versioned pair.
 
685
        """
 
686
        result = []
 
687
        lookup_trees = [self.source]
 
688
        if extra_trees:
 
689
             lookup_trees.extend(extra_trees)
 
690
        if specific_files == []:
 
691
            specific_file_ids = []
 
692
        else:
 
693
            specific_file_ids = self.target.paths2ids(specific_files,
 
694
                lookup_trees, require_versioned=require_versioned)
 
695
        if want_unversioned:
 
696
            all_unversioned = sorted([(p.split('/'), p) for p in
 
697
                                     self.target.extras()
 
698
                if specific_files is None or
 
699
                    osutils.is_inside_any(specific_files, p)])
 
700
            all_unversioned = deque(all_unversioned)
 
701
        else:
 
702
            all_unversioned = deque()
 
703
        to_paths = {}
 
704
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
705
            specific_file_ids=specific_file_ids))
 
706
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
707
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
708
            specific_file_ids=specific_file_ids))
 
709
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
710
        entry_count = 0
 
711
        # the unversioned path lookup only occurs on real trees - where there 
 
712
        # can be extras. So the fake_entry is solely used to look up
 
713
        # executable it values when execute is not supported.
 
714
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
715
        for to_path, to_entry in to_entries_by_dir:
 
716
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
717
                unversioned_path = all_unversioned.popleft()
 
718
                to_kind, to_executable, to_stat = \
 
719
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
720
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
721
                    (None, None),
 
722
                    (None, unversioned_path[0][-1]),
 
723
                    (None, to_kind),
 
724
                    (None, to_executable))
 
725
            file_id = to_entry.file_id
 
726
            to_paths[file_id] = to_path
 
727
            entry_count += 1
 
728
            changed_content = False
 
729
            from_path, from_entry = from_data.get(file_id, (None, None))
 
730
            from_versioned = (from_entry is not None)
 
731
            if from_entry is not None:
 
732
                from_versioned = True
 
733
                from_name = from_entry.name
 
734
                from_parent = from_entry.parent_id
 
735
                from_kind, from_executable, from_stat = \
 
736
                    self.source._comparison_data(from_entry, from_path)
 
737
                entry_count += 1
 
738
            else:
 
739
                from_versioned = False
 
740
                from_kind = None
 
741
                from_parent = None
 
742
                from_name = None
 
743
                from_executable = None
 
744
            versioned = (from_versioned, True)
 
745
            to_kind, to_executable, to_stat = \
 
746
                self.target._comparison_data(to_entry, to_path)
 
747
            kind = (from_kind, to_kind)
 
748
            if kind[0] != kind[1]:
 
749
                changed_content = True
 
750
            elif from_kind == 'file':
 
751
                from_size = self.source._file_size(from_entry, from_stat)
 
752
                to_size = self.target._file_size(to_entry, to_stat)
 
753
                if from_size != to_size:
 
754
                    changed_content = True
 
755
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
756
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
757
                    changed_content = True
 
758
            elif from_kind == 'symlink':
 
759
                if (self.source.get_symlink_target(file_id) !=
 
760
                    self.target.get_symlink_target(file_id)):
 
761
                    changed_content = True
 
762
                elif from_kind == 'tree-reference':
 
763
                    if (self.source.get_reference_revision(file_id, from_path)
 
764
                        != self.target.get_reference_revision(file_id, to_path)):
 
765
                        changed_content = True 
 
766
            parent = (from_parent, to_entry.parent_id)
 
767
            name = (from_name, to_entry.name)
 
768
            executable = (from_executable, to_executable)
 
769
            if pb is not None:
 
770
                pb.update('comparing files', entry_count, num_entries)
 
771
            if (changed_content is not False or versioned[0] != versioned[1]
 
772
                or parent[0] != parent[1] or name[0] != name[1] or 
 
773
                executable[0] != executable[1] or include_unchanged):
 
774
                yield (file_id, (from_path, to_path), changed_content,
 
775
                    versioned, parent, name, kind, executable)
 
776
 
 
777
        while all_unversioned:
 
778
            # yield any trailing unversioned paths
 
779
            unversioned_path = all_unversioned.popleft()
 
780
            to_kind, to_executable, to_stat = \
 
781
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
782
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
783
                (None, None),
 
784
                (None, unversioned_path[0][-1]),
 
785
                (None, to_kind),
 
786
                (None, to_executable))
 
787
 
 
788
        def get_to_path(to_entry):
 
789
            if to_entry.parent_id is None:
 
790
                to_path = '' # the root
 
791
            else:
 
792
                if to_entry.parent_id not in to_paths:
 
793
                    # recurse up
 
794
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
795
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
796
                                           to_entry.name)
 
797
            to_paths[to_entry.file_id] = to_path
 
798
            return to_path
 
799
 
 
800
        for path, from_entry in from_entries_by_dir:
 
801
            file_id = from_entry.file_id
 
802
            if file_id in to_paths:
 
803
                # already returned
 
804
                continue
 
805
            if not file_id in self.target.inventory:
 
806
                # common case - paths we have not emitted are not present in
 
807
                # target.
 
808
                to_path = None
 
809
            else:
 
810
                to_path = get_to_path(self.target.inventory[file_id])
 
811
            entry_count += 1
 
812
            if pb is not None:
 
813
                pb.update('comparing files', entry_count, num_entries)
 
814
            versioned = (True, False)
 
815
            parent = (from_entry.parent_id, None)
 
816
            name = (from_entry.name, None)
 
817
            from_kind, from_executable, stat_value = \
 
818
                self.source._comparison_data(from_entry, path)
 
819
            kind = (from_kind, None)
 
820
            executable = (from_executable, None)
 
821
            changed_content = True
 
822
            # the parent's path is necessarily known at this point.
 
823
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
824
                  name, kind, executable)
 
825
 
 
826
 
 
827
# This was deprecated before 0.12, but did not have an official warning
 
828
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
829
def RevisionTree(*args, **kwargs):
 
830
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
831
 
 
832
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
833
    bzr 0.12.
 
834
    """
 
835
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
836
    return _RevisionTree(*args, **kwargs)
 
837
 
 
838