← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Robert Collins
  • Date: 2006-03-01 03:26:23 UTC
  • mto: (1594.2.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1596.
  • Revision ID: robertc@robertcollins.net-20060301032623-9d3c073e102f2239
Move WeaveStore down into bzrlib.store.versioned.weave.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2006 Canonical Ltd
 
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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import errno
19
 
from stat import S_ISREG, S_IEXEC
20
 
import time
 
19
from stat import S_ISREG
21
20
 
22
 
from bzrlib import (
23
 
    errors,
24
 
    lazy_import,
25
 
    registry,
26
 
    trace,
27
 
    tree,
28
 
    )
29
 
lazy_import.lazy_import(globals(), """
30
 
from bzrlib import (
31
 
    annotate,
32
 
    bencode,
33
 
    bzrdir,
34
 
    commit,
35
 
    conflicts,
36
 
    delta,
37
 
    errors,
38
 
    inventory,
39
 
    multiparent,
40
 
    osutils,
41
 
    revision as _mod_revision,
42
 
    ui,
43
 
    urlutils,
44
 
    )
45
 
from bzrlib.i18n import gettext
46
 
""")
47
21
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
48
 
                           ReusingTransform, CantMoveRoot,
49
 
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
50
 
                           UnableCreateSymlink)
51
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
52
 
from bzrlib.osutils import (
53
 
    delete_any,
54
 
    file_kind,
55
 
    has_symlinks,
56
 
    pathjoin,
57
 
    sha_file,
58
 
    splitpath,
59
 
    supports_executable,
60
 
    )
61
 
from bzrlib.progress import ProgressPhase
62
 
from bzrlib.symbol_versioning import (
63
 
    deprecated_function,
64
 
    deprecated_in,
65
 
    deprecated_method,
66
 
    )
 
22
                           ReusingTransform, NotVersionedError, CantMoveRoot,
 
23
                           ExistingLimbo, ImmortalLimbo)
 
24
from bzrlib.inventory import InventoryEntry
 
25
from bzrlib.osutils import file_kind, supports_executable, pathjoin
 
26
from bzrlib.progress import DummyProgress
 
27
from bzrlib.trace import mutter, warning
67
28
 
68
29
 
69
30
ROOT_PARENT = "root-parent"
70
31
 
 
32
 
71
33
def unique_add(map, key, value):
72
34
    if key in map:
73
35
        raise DuplicateKey(key=key)
74
36
    map[key] = value
75
37
 
76
38
 
77
 
 
78
 
class _TransformResults(object):
79
 
    def __init__(self, modified_paths, rename_count):
80
 
        object.__init__(self)
81
 
        self.modified_paths = modified_paths
82
 
        self.rename_count = rename_count
83
 
 
84
 
 
85
 
class TreeTransformBase(object):
86
 
    """The base class for TreeTransform and its kin."""
87
 
 
88
 
    def __init__(self, tree, pb=None,
89
 
                 case_sensitive=True):
90
 
        """Constructor.
91
 
 
92
 
        :param tree: The tree that will be transformed, but not necessarily
93
 
            the output tree.
94
 
        :param pb: ignored
95
 
        :param case_sensitive: If True, the target of the transform is
96
 
            case sensitive, not just case preserving.
 
39
class TreeTransform(object):
 
40
    """Represent a tree transformation.
 
41
    
 
42
    This object is designed to support incremental generation of the transform,
 
43
    in any order.  
 
44
    
 
45
    It is easy to produce malformed transforms, but they are generally
 
46
    harmless.  Attempting to apply a malformed transform will cause an
 
47
    exception to be raised before any modifications are made to the tree.  
 
48
 
 
49
    Many kinds of malformed transforms can be corrected with the 
 
50
    resolve_conflicts function.  The remaining ones indicate programming error,
 
51
    such as trying to create a file with no path.
 
52
 
 
53
    Two sets of file creation methods are supplied.  Convenience methods are:
 
54
     * new_file
 
55
     * new_directory
 
56
     * new_symlink
 
57
 
 
58
    These are composed of the low-level methods:
 
59
     * create_path
 
60
     * create_file or create_directory or create_symlink
 
61
     * version_file
 
62
     * set_executability
 
63
    """
 
64
    def __init__(self, tree, pb=DummyProgress()):
 
65
        """Note: a write lock is taken on the tree.
 
66
        
 
67
        Use TreeTransform.finalize() to release the lock
97
68
        """
98
69
        object.__init__(self)
99
70
        self._tree = tree
 
71
        self._tree.lock_write()
 
72
        try:
 
73
            control_files = self._tree._control_files
 
74
            self._limbodir = control_files.controlfilename('limbo')
 
75
            try:
 
76
                os.mkdir(self._limbodir)
 
77
            except OSError, e:
 
78
                if e.errno == errno.EEXIST:
 
79
                    raise ExistingLimbo(self._limbodir)
 
80
        except: 
 
81
            self._tree.unlock()
 
82
            raise
 
83
 
100
84
        self._id_number = 0
101
 
        # mapping of trans_id -> new basename
102
85
        self._new_name = {}
103
 
        # mapping of trans_id -> new parent trans_id
104
86
        self._new_parent = {}
105
 
        # mapping of trans_id with new contents -> new file_kind
106
87
        self._new_contents = {}
107
 
        # mapping of trans_id => (sha1 of content, stat_value)
108
 
        self._observed_sha1s = {}
109
 
        # Set of trans_ids whose contents will be removed
110
88
        self._removed_contents = set()
111
 
        # Mapping of trans_id -> new execute-bit value
112
89
        self._new_executability = {}
113
 
        # Mapping of trans_id -> new tree-reference value
114
 
        self._new_reference_revision = {}
115
 
        # Mapping of trans_id -> new file_id
116
90
        self._new_id = {}
117
 
        # Mapping of old file-id -> trans_id
118
91
        self._non_present_ids = {}
119
 
        # Mapping of new file_id -> trans_id
120
92
        self._r_new_id = {}
121
 
        # Set of trans_ids that will be removed
122
93
        self._removed_id = set()
123
 
        # Mapping of path in old tree -> trans_id
124
94
        self._tree_path_ids = {}
125
 
        # Mapping trans_id -> path in old tree
126
95
        self._tree_id_paths = {}
127
 
        # The trans_id that will be used as the tree root
128
 
        root_id = tree.get_root_id()
129
 
        if root_id is not None:
130
 
            self._new_root = self.trans_id_tree_file_id(root_id)
131
 
        else:
132
 
            self._new_root = None
133
 
        # Indicator of whether the transform has been applied
134
 
        self._done = False
135
 
        # A progress bar
 
96
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
97
        self.__done = False
136
98
        self._pb = pb
137
 
        # Whether the target is case sensitive
138
 
        self._case_sensitive_target = case_sensitive
139
 
        # A counter of how many files have been renamed
140
 
        self.rename_count = 0
141
 
 
142
 
    def __enter__(self):
143
 
        """Support Context Manager API."""
144
 
        return self
145
 
 
146
 
    def __exit__(self, exc_type, exc_val, exc_tb):
147
 
        """Support Context Manager API."""
148
 
        self.finalize()
149
 
 
150
 
    def finalize(self):
151
 
        """Release the working tree lock, if held.
152
 
 
153
 
        This is required if apply has not been invoked, but can be invoked
154
 
        even after apply.
155
 
        """
156
 
        if self._tree is None:
157
 
            return
158
 
        self._tree.unlock()
159
 
        self._tree = None
160
99
 
161
100
    def __get_root(self):
162
101
        return self._new_root
163
102
 
164
103
    root = property(__get_root)
165
104
 
 
105
    def finalize(self):
 
106
        """Release the working tree lock, if held, clean up limbo dir."""
 
107
        if self._tree is None:
 
108
            return
 
109
        try:
 
110
            for trans_id, kind in self._new_contents.iteritems():
 
111
                path = self._limbo_name(trans_id)
 
112
                if kind == "directory":
 
113
                    os.rmdir(path)
 
114
                else:
 
115
                    os.unlink(path)
 
116
            try:
 
117
                os.rmdir(self._limbodir)
 
118
            except OSError:
 
119
                # We don't especially care *why* the dir is immortal.
 
120
                raise ImmortalLimbo(self._limbodir)
 
121
        finally:
 
122
            self._tree.unlock()
 
123
            self._tree = None
 
124
 
166
125
    def _assign_id(self):
167
126
        """Produce a new tranform id"""
168
127
        new_id = "new-%s" % self._id_number
178
137
 
179
138
    def adjust_path(self, name, parent, trans_id):
180
139
        """Change the path that is assigned to a transaction id."""
181
 
        if parent is None:
182
 
            raise ValueError("Parent trans-id may not be None")
183
140
        if trans_id == self._new_root:
184
141
            raise CantMoveRoot
185
142
        self._new_name[trans_id] = name
187
144
 
188
145
    def adjust_root_path(self, name, parent):
189
146
        """Emulate moving the root by moving all children, instead.
190
 
 
 
147
        
191
148
        We do this by undoing the association of root's transaction id with the
192
149
        current tree.  This allows us to create a new directory with that
193
 
        transaction id.  We unversion the root directory and version the
 
150
        transaction id.  We unversion the root directory and version the 
194
151
        physically new directory, and hope someone versions the tree root
195
152
        later.
196
153
        """
199
156
        # force moving all children of root
200
157
        for child_id in self.iter_tree_children(old_root):
201
158
            if child_id != parent:
202
 
                self.adjust_path(self.final_name(child_id),
 
159
                self.adjust_path(self.final_name(child_id), 
203
160
                                 self.final_parent(child_id), child_id)
204
161
            file_id = self.final_file_id(child_id)
205
162
            if file_id is not None:
206
163
                self.unversion_file(child_id)
207
164
            self.version_file(file_id, child_id)
208
 
 
 
165
        
209
166
        # the physical root needs a new transaction id
210
167
        self._tree_path_ids.pop("")
211
168
        self._tree_id_paths.pop(old_root)
217
174
        self.version_file(old_root_file_id, old_root)
218
175
        self.unversion_file(self._new_root)
219
176
 
220
 
    def fixup_new_roots(self):
221
 
        """Reinterpret requests to change the root directory
222
 
 
223
 
        Instead of creating a root directory, or moving an existing directory,
224
 
        all the attributes and children of the new root are applied to the
225
 
        existing root directory.
226
 
 
227
 
        This means that the old root trans-id becomes obsolete, so it is
228
 
        recommended only to invoke this after the root trans-id has become
229
 
        irrelevant.
230
 
 
231
 
        """
232
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
233
 
                     ROOT_PARENT]
234
 
        if len(new_roots) < 1:
235
 
            return
236
 
        if len(new_roots) != 1:
237
 
            raise ValueError('A tree cannot have two roots!')
238
 
        if self._new_root is None:
239
 
            self._new_root = new_roots[0]
240
 
            return
241
 
        old_new_root = new_roots[0]
242
 
        # unversion the new root's directory.
243
 
        if self.final_kind(self._new_root) is None:
244
 
            file_id = self.final_file_id(old_new_root)
245
 
        else:
246
 
            file_id = self.final_file_id(self._new_root)
247
 
        if old_new_root in self._new_id:
248
 
            self.cancel_versioning(old_new_root)
249
 
        else:
250
 
            self.unversion_file(old_new_root)
251
 
        # if, at this stage, root still has an old file_id, zap it so we can
252
 
        # stick a new one in.
253
 
        if (self.tree_file_id(self._new_root) is not None and
254
 
            self._new_root not in self._removed_id):
255
 
            self.unversion_file(self._new_root)
256
 
        if file_id is not None:
257
 
            self.version_file(file_id, self._new_root)
258
 
 
259
 
        # Now move children of new root into old root directory.
260
 
        # Ensure all children are registered with the transaction, but don't
261
 
        # use directly-- some tree children have new parents
262
 
        list(self.iter_tree_children(old_new_root))
263
 
        # Move all children of new root into old root directory.
264
 
        for child in self.by_parent().get(old_new_root, []):
265
 
            self.adjust_path(self.final_name(child), self._new_root, child)
266
 
 
267
 
        # Ensure old_new_root has no directory.
268
 
        if old_new_root in self._new_contents:
269
 
            self.cancel_creation(old_new_root)
270
 
        else:
271
 
            self.delete_contents(old_new_root)
272
 
 
273
 
        # prevent deletion of root directory.
274
 
        if self._new_root in self._removed_contents:
275
 
            self.cancel_deletion(self._new_root)
276
 
 
277
 
        # destroy path info for old_new_root.
278
 
        del self._new_parent[old_new_root]
279
 
        del self._new_name[old_new_root]
280
 
 
281
177
    def trans_id_tree_file_id(self, inventory_id):
282
178
        """Determine the transaction id of a working tree file.
283
 
 
 
179
        
284
180
        This reflects only files that already exist, not ones that will be
285
181
        added by transactions.
286
182
        """
287
 
        if inventory_id is None:
288
 
            raise ValueError('None is not a valid file id')
289
 
        path = self._tree.id2path(inventory_id)
 
183
        path = self._tree.inventory.id2path(inventory_id)
290
184
        return self.trans_id_tree_path(path)
291
185
 
292
186
    def trans_id_file_id(self, file_id):
295
189
        a transaction has been unversioned, it is deliberately still returned.
296
190
        (this will likely lead to an unversioned parent conflict.)
297
191
        """
298
 
        if file_id is None:
299
 
            raise ValueError('None is not a valid file id')
300
192
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
301
193
            return self._r_new_id[file_id]
 
194
        elif file_id in self._tree.inventory:
 
195
            return self.trans_id_tree_file_id(file_id)
 
196
        elif file_id in self._non_present_ids:
 
197
            return self._non_present_ids[file_id]
302
198
        else:
303
 
            try:
304
 
                self._tree.iter_entries_by_dir([file_id]).next()
305
 
            except StopIteration:
306
 
                if file_id in self._non_present_ids:
307
 
                    return self._non_present_ids[file_id]
308
 
                else:
309
 
                    trans_id = self._assign_id()
310
 
                    self._non_present_ids[file_id] = trans_id
311
 
                    return trans_id
312
 
            else:
313
 
                return self.trans_id_tree_file_id(file_id)
 
199
            trans_id = self._assign_id()
 
200
            self._non_present_ids[file_id] = trans_id
 
201
            return trans_id
 
202
 
 
203
    def canonical_path(self, path):
 
204
        """Get the canonical tree-relative path"""
 
205
        # don't follow final symlinks
 
206
        dirname, basename = os.path.split(self._tree.abspath(path))
 
207
        dirname = os.path.realpath(dirname)
 
208
        return self._tree.relpath(pathjoin(dirname, basename))
314
209
 
315
210
    def trans_id_tree_path(self, path):
316
211
        """Determine (and maybe set) the transaction ID for a tree path."""
327
222
            return ROOT_PARENT
328
223
        return self.trans_id_tree_path(os.path.dirname(path))
329
224
 
 
225
    def create_file(self, contents, trans_id, mode_id=None):
 
226
        """Schedule creation of a new file.
 
227
 
 
228
        See also new_file.
 
229
        
 
230
        Contents is an iterator of strings, all of which will be written
 
231
        to the target destination.
 
232
 
 
233
        New file takes the permissions of any existing file with that id,
 
234
        unless mode_id is specified.
 
235
        """
 
236
        f = file(self._limbo_name(trans_id), 'wb')
 
237
        unique_add(self._new_contents, trans_id, 'file')
 
238
        for segment in contents:
 
239
            f.write(segment)
 
240
        f.close()
 
241
        self._set_mode(trans_id, mode_id, S_ISREG)
 
242
 
 
243
    def _set_mode(self, trans_id, mode_id, typefunc):
 
244
        """Set the mode of new file contents.
 
245
        The mode_id is the existing file to get the mode from (often the same
 
246
        as trans_id).  The operation is only performed if there's a mode match
 
247
        according to typefunc.
 
248
        """
 
249
        if mode_id is None:
 
250
            mode_id = trans_id
 
251
        try:
 
252
            old_path = self._tree_id_paths[mode_id]
 
253
        except KeyError:
 
254
            return
 
255
        try:
 
256
            mode = os.stat(old_path).st_mode
 
257
        except OSError, e:
 
258
            if e.errno == errno.ENOENT:
 
259
                return
 
260
            else:
 
261
                raise
 
262
        if typefunc(mode):
 
263
            os.chmod(self._limbo_name(trans_id), mode)
 
264
 
 
265
    def create_directory(self, trans_id):
 
266
        """Schedule creation of a new directory.
 
267
        
 
268
        See also new_directory.
 
269
        """
 
270
        os.mkdir(self._limbo_name(trans_id))
 
271
        unique_add(self._new_contents, trans_id, 'directory')
 
272
 
 
273
    def create_symlink(self, target, trans_id):
 
274
        """Schedule creation of a new symbolic link.
 
275
 
 
276
        target is a bytestring.
 
277
        See also new_symlink.
 
278
        """
 
279
        os.symlink(target, self._limbo_name(trans_id))
 
280
        unique_add(self._new_contents, trans_id, 'symlink')
 
281
 
 
282
    @staticmethod
 
283
    def delete_any(full_path):
 
284
        """Delete a file or directory."""
 
285
        try:
 
286
            os.unlink(full_path)
 
287
        except OSError, e:
 
288
        # We may be renaming a dangling inventory id
 
289
            if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
 
290
                raise
 
291
            os.rmdir(full_path)
 
292
 
 
293
    def cancel_creation(self, trans_id):
 
294
        """Cancel the creation of new file contents."""
 
295
        del self._new_contents[trans_id]
 
296
        self.delete_any(self._limbo_name(trans_id))
 
297
 
330
298
    def delete_contents(self, trans_id):
331
299
        """Schedule the contents of a path entry for deletion"""
332
 
        kind = self.tree_kind(trans_id)
333
 
        if kind is not None:
334
 
            self._removed_contents.add(trans_id)
 
300
        self.tree_kind(trans_id)
 
301
        self._removed_contents.add(trans_id)
335
302
 
336
303
    def cancel_deletion(self, trans_id):
337
304
        """Cancel a scheduled deletion"""
355
322
        else:
356
323
            unique_add(self._new_executability, trans_id, executability)
357
324
 
358
 
    def set_tree_reference(self, revision_id, trans_id):
359
 
        """Set the reference associated with a directory"""
360
 
        unique_add(self._new_reference_revision, trans_id, revision_id)
361
 
 
362
325
    def version_file(self, file_id, trans_id):
363
326
        """Schedule a file to become versioned."""
364
 
        if file_id is None:
365
 
            raise ValueError()
 
327
        assert file_id is not None
366
328
        unique_add(self._new_id, trans_id, file_id)
367
329
        unique_add(self._r_new_id, file_id, trans_id)
368
330
 
372
334
        del self._new_id[trans_id]
373
335
        del self._r_new_id[file_id]
374
336
 
375
 
    def new_paths(self, filesystem_only=False):
376
 
        """Determine the paths of all new and changed files.
377
 
 
378
 
        :param filesystem_only: if True, only calculate values for files
379
 
            that require renames or execute bit changes.
380
 
        """
 
337
    def new_paths(self):
 
338
        """Determine the paths of all new and changed files"""
381
339
        new_ids = set()
382
 
        if filesystem_only:
383
 
            stale_ids = self._needs_rename.difference(self._new_name)
384
 
            stale_ids.difference_update(self._new_parent)
385
 
            stale_ids.difference_update(self._new_contents)
386
 
            stale_ids.difference_update(self._new_id)
387
 
            needs_rename = self._needs_rename.difference(stale_ids)
388
 
            id_sets = (needs_rename, self._new_executability)
389
 
        else:
390
 
            id_sets = (self._new_name, self._new_parent, self._new_contents,
391
 
                       self._new_id, self._new_executability)
392
 
        for id_set in id_sets:
 
340
        fp = FinalPaths(self)
 
341
        for id_set in (self._new_name, self._new_parent, self._new_contents,
 
342
                       self._new_id, self._new_executability):
393
343
            new_ids.update(id_set)
394
 
        return sorted(FinalPaths(self).get_paths(new_ids))
395
 
 
396
 
    def _inventory_altered(self):
397
 
        """Determine which trans_ids need new Inventory entries.
398
 
 
399
 
        An new entry is needed when anything that would be reflected by an
400
 
        inventory entry changes, including file name, file_id, parent file_id,
401
 
        file kind, and the execute bit.
402
 
 
403
 
        Some care is taken to return entries with real changes, not cases
404
 
        where the value is deleted and then restored to its original value,
405
 
        but some actually unchanged values may be returned.
406
 
 
407
 
        :returns: A list of (path, trans_id) for all items requiring an
408
 
            inventory change. Ordered by path.
 
344
        new_paths = [(fp.get_path(t), t) for t in new_ids]
 
345
        new_paths.sort()
 
346
        return new_paths
 
347
 
 
348
    def tree_kind(self, trans_id):
 
349
        """Determine the file kind in the working tree.
 
350
 
 
351
        Raises NoSuchFile if the file does not exist
409
352
        """
410
 
        changed_ids = set()
411
 
        # Find entries whose file_ids are new (or changed).
412
 
        new_file_id = set(t for t in self._new_id
413
 
                          if self._new_id[t] != self.tree_file_id(t))
414
 
        for id_set in [self._new_name, self._new_parent, new_file_id,
415
 
                       self._new_executability]:
416
 
            changed_ids.update(id_set)
417
 
        # removing implies a kind change
418
 
        changed_kind = set(self._removed_contents)
419
 
        # so does adding
420
 
        changed_kind.intersection_update(self._new_contents)
421
 
        # Ignore entries that are already known to have changed.
422
 
        changed_kind.difference_update(changed_ids)
423
 
        #  to keep only the truly changed ones
424
 
        changed_kind = (t for t in changed_kind
425
 
                        if self.tree_kind(t) != self.final_kind(t))
426
 
        # all kind changes will alter the inventory
427
 
        changed_ids.update(changed_kind)
428
 
        # To find entries with changed parent_ids, find parents which existed,
429
 
        # but changed file_id.
430
 
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
431
 
        # Now add all their children to the set.
432
 
        for parent_trans_id in new_file_id:
433
 
            changed_ids.update(self.iter_tree_children(parent_trans_id))
434
 
        return sorted(FinalPaths(self).get_paths(changed_ids))
 
353
        path = self._tree_id_paths.get(trans_id)
 
354
        if path is None:
 
355
            raise NoSuchFile(None)
 
356
        try:
 
357
            return file_kind(self._tree.abspath(path))
 
358
        except OSError, e:
 
359
            if e.errno != errno.ENOENT:
 
360
                raise
 
361
            else:
 
362
                raise NoSuchFile(path)
435
363
 
436
364
    def final_kind(self, trans_id):
437
365
        """Determine the final file kind, after any changes applied.
438
 
 
439
 
        :return: None if the file does not exist/has no contents.  (It is
440
 
            conceivable that a path would be created without the corresponding
441
 
            contents insertion command)
 
366
        
 
367
        Raises NoSuchFile if the file does not exist/has no contents.
 
368
        (It is conceivable that a path would be created without the
 
369
        corresponding contents insertion command)
442
370
        """
443
371
        if trans_id in self._new_contents:
444
372
            return self._new_contents[trans_id]
445
373
        elif trans_id in self._removed_contents:
446
 
            return None
 
374
            raise NoSuchFile(None)
447
375
        else:
448
376
            return self.tree_kind(trans_id)
449
377
 
456
384
            return None
457
385
        # the file is old; the old id is still valid
458
386
        if self._new_root == trans_id:
459
 
            return self._tree.get_root_id()
460
 
        return self._tree.path2id(path)
 
387
            return self._tree.inventory.root.file_id
 
388
        return self._tree.inventory.path2id(path)
461
389
 
462
390
    def final_file_id(self, trans_id):
463
391
        """Determine the file id after any changes are applied, or None.
464
 
 
 
392
        
465
393
        None indicates that the file will not be versioned after changes are
466
394
        applied.
467
395
        """
468
396
        try:
 
397
            # there is a new id for this file
 
398
            assert self._new_id[trans_id] is not None
469
399
            return self._new_id[trans_id]
470
400
        except KeyError:
471
401
            if trans_id in self._removed_id:
499
429
        try:
500
430
            return self._new_name[trans_id]
501
431
        except KeyError:
502
 
            try:
503
 
                return os.path.basename(self._tree_id_paths[trans_id])
504
 
            except KeyError:
505
 
                raise NoFinalPath(trans_id, self)
 
432
            return os.path.basename(self._tree_id_paths[trans_id])
506
433
 
507
 
    def by_parent(self):
 
434
    def _by_parent(self):
508
435
        """Return a map of parent: children for known parents.
509
 
 
 
436
        
510
437
        Only new paths and parents of tree files with assigned ids are used.
511
438
        """
512
439
        by_parent = {}
513
440
        items = list(self._new_parent.iteritems())
514
 
        items.extend((t, self.final_parent(t)) for t in
 
441
        items.extend((t, self.final_parent(t)) for t in 
515
442
                      self._tree_id_paths.keys())
516
443
        for trans_id, parent_id in items:
517
444
            if parent_id not in by_parent:
521
448
 
522
449
    def path_changed(self, trans_id):
523
450
        """Return True if a trans_id's path has changed."""
524
 
        return (trans_id in self._new_name) or (trans_id in self._new_parent)
525
 
 
526
 
    def new_contents(self, trans_id):
527
 
        return (trans_id in self._new_contents)
 
451
        return trans_id in self._new_name or trans_id in self._new_parent
528
452
 
529
453
    def find_conflicts(self):
530
454
        """Find any violations of inventory or filesystem invariants"""
531
 
        if self._done is True:
 
455
        if self.__done is True:
532
456
            raise ReusingTransform()
533
457
        conflicts = []
534
458
        # ensure all children of all existent parents are known
535
459
        # all children of non-existent parents are known, by definition.
536
460
        self._add_tree_children()
537
 
        by_parent = self.by_parent()
 
461
        by_parent = self._by_parent()
538
462
        conflicts.extend(self._unversioned_parents(by_parent))
539
463
        conflicts.extend(self._parent_loops())
540
464
        conflicts.extend(self._duplicate_entries(by_parent))
545
469
        conflicts.extend(self._overwrite_conflicts())
546
470
        return conflicts
547
471
 
548
 
    def _check_malformed(self):
549
 
        conflicts = self.find_conflicts()
550
 
        if len(conflicts) != 0:
551
 
            raise MalformedTransform(conflicts=conflicts)
552
 
 
553
472
    def _add_tree_children(self):
554
473
        """Add all the children of all active parents to the known paths.
555
474
 
556
475
        Active parents are those which gain children, and those which are
557
476
        removed.  This is a necessary first step in detecting conflicts.
558
477
        """
559
 
        parents = self.by_parent().keys()
560
 
        parents.extend([t for t in self._removed_contents if
 
478
        parents = self._by_parent().keys()
 
479
        parents.extend([t for t in self._removed_contents if 
561
480
                        self.tree_kind(t) == 'directory'])
562
481
        for trans_id in self._removed_id:
563
482
            file_id = self.tree_file_id(trans_id)
564
 
            if file_id is not None:
565
 
                # XXX: This seems like something that should go via a different
566
 
                #      indirection.
567
 
                if self._tree.inventory[file_id].kind == 'directory':
568
 
                    parents.append(trans_id)
569
 
            elif self.tree_kind(trans_id) == 'directory':
 
483
            if self._tree.inventory[file_id].kind in ('directory', 
 
484
                                                      'root_directory'):
570
485
                parents.append(trans_id)
571
486
 
572
487
        for parent_id in parents:
573
488
            # ensure that all children are registered with the transaction
574
489
            list(self.iter_tree_children(parent_id))
575
490
 
576
 
    @deprecated_method(deprecated_in((2, 3, 0)))
577
 
    def has_named_child(self, by_parent, parent_id, name):
578
 
        return self._has_named_child(
579
 
            name, parent_id, known_children=by_parent.get(parent_id, []))
580
 
 
581
 
    def _has_named_child(self, name, parent_id, known_children):
582
 
        """Does a parent already have a name child.
583
 
 
584
 
        :param name: The searched for name.
585
 
 
586
 
        :param parent_id: The parent for which the check is made.
587
 
 
588
 
        :param known_children: The already known children. This should have
589
 
            been recently obtained from `self.by_parent.get(parent_id)`
590
 
            (or will be if None is passed).
591
 
        """
592
 
        if known_children is None:
593
 
            known_children = self.by_parent().get(parent_id, [])
594
 
        for child in known_children:
595
 
            if self.final_name(child) == name:
596
 
                return True
597
 
        parent_path = self._tree_id_paths.get(parent_id, None)
598
 
        if parent_path is None:
599
 
            # No parent... no children
600
 
            return False
601
 
        child_path = joinpath(parent_path, name)
602
 
        child_id = self._tree_path_ids.get(child_path, None)
603
 
        if child_id is None:
604
 
            # Not known by the tree transform yet, check the filesystem
605
 
            return osutils.lexists(self._tree.abspath(child_path))
606
 
        else:
607
 
            raise AssertionError('child_id is missing: %s, %s, %s'
608
 
                                 % (name, parent_id, child_id))
609
 
 
610
 
    def _available_backup_name(self, name, target_id):
611
 
        """Find an available backup name.
612
 
 
613
 
        :param name: The basename of the file.
614
 
 
615
 
        :param target_id: The directory trans_id where the backup should 
616
 
            be placed.
617
 
        """
618
 
        known_children = self.by_parent().get(target_id, [])
619
 
        return osutils.available_backup_name(
620
 
            name,
621
 
            lambda base: self._has_named_child(
622
 
                base, target_id, known_children))
 
491
    def iter_tree_children(self, parent_id):
 
492
        """Iterate through the entry's tree children, if any"""
 
493
        try:
 
494
            path = self._tree_id_paths[parent_id]
 
495
        except KeyError:
 
496
            return
 
497
        try:
 
498
            children = os.listdir(self._tree.abspath(path))
 
499
        except OSError, e:
 
500
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
 
501
                raise
 
502
            return
 
503
            
 
504
        for child in children:
 
505
            childpath = joinpath(path, child)
 
506
            if self._tree.is_control_filename(childpath):
 
507
                continue
 
508
            yield self.trans_id_tree_path(childpath)
623
509
 
624
510
    def _parent_loops(self):
625
511
        """No entry should be its own ancestor"""
629
515
            parent_id = trans_id
630
516
            while parent_id is not ROOT_PARENT:
631
517
                seen.add(parent_id)
632
 
                try:
633
 
                    parent_id = self.final_parent(parent_id)
634
 
                except KeyError:
635
 
                    break
 
518
                parent_id = self.final_parent(parent_id)
636
519
                if parent_id == trans_id:
637
520
                    conflicts.append(('parent loop', trans_id))
638
521
                if parent_id in seen:
655
538
 
656
539
    def _improper_versioning(self):
657
540
        """Cannot version a file with no contents, or a bad type.
658
 
 
 
541
        
659
542
        However, existing entries with no contents are okay.
660
543
        """
661
544
        conflicts = []
662
545
        for trans_id in self._new_id.iterkeys():
663
 
            kind = self.final_kind(trans_id)
664
 
            if kind is None:
 
546
            try:
 
547
                kind = self.final_kind(trans_id)
 
548
            except NoSuchFile:
665
549
                conflicts.append(('versioning no contents', trans_id))
666
550
                continue
667
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
551
            if not InventoryEntry.versionable_kind(kind):
668
552
                conflicts.append(('versioning bad kind', trans_id, kind))
669
553
        return conflicts
670
554
 
671
555
    def _executability_conflicts(self):
672
556
        """Check for bad executability changes.
673
 
 
 
557
        
674
558
        Only versioned files may have their executability set, because
675
559
        1. only versioned entries can have executability under windows
676
560
        2. only files can be executable.  (The execute bit on a directory
681
565
            if self.final_file_id(trans_id) is None:
682
566
                conflicts.append(('unversioned executability', trans_id))
683
567
            else:
684
 
                if self.final_kind(trans_id) != "file":
 
568
                try:
 
569
                    non_file = self.final_kind(trans_id) != "file"
 
570
                except NoSuchFile:
 
571
                    non_file = True
 
572
                if non_file is True:
685
573
                    conflicts.append(('non-file executability', trans_id))
686
574
        return conflicts
687
575
 
689
577
        """Check for overwrites (not permitted on Win32)"""
690
578
        conflicts = []
691
579
        for trans_id in self._new_contents:
692
 
            if self.tree_kind(trans_id) is None:
 
580
            try:
 
581
                self.tree_kind(trans_id)
 
582
            except NoSuchFile:
693
583
                continue
694
584
            if trans_id not in self._removed_contents:
695
585
                conflicts.append(('overwrite', trans_id,
699
589
    def _duplicate_entries(self, by_parent):
700
590
        """No directory may have two entries with the same name."""
701
591
        conflicts = []
702
 
        if (self._new_name, self._new_parent) == ({}, {}):
703
 
            return conflicts
704
592
        for children in by_parent.itervalues():
705
 
            name_ids = []
706
 
            for child_tid in children:
707
 
                name = self.final_name(child_tid)
708
 
                if name is not None:
709
 
                    # Keep children only if they still exist in the end
710
 
                    if not self._case_sensitive_target:
711
 
                        name = name.lower()
712
 
                    name_ids.append((name, child_tid))
 
593
            name_ids = [(self.final_name(t), t) for t in children]
713
594
            name_ids.sort()
714
595
            last_name = None
715
596
            last_trans_id = None
716
597
            for name, trans_id in name_ids:
717
 
                kind = self.final_kind(trans_id)
718
 
                file_id = self.final_file_id(trans_id)
719
 
                if kind is None and file_id is None:
720
 
                    continue
721
598
                if name == last_name:
722
599
                    conflicts.append(('duplicate', last_trans_id, trans_id,
723
600
                    name))
730
607
        conflicts = []
731
608
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
732
609
                                self._removed_id))
733
 
        all_ids = self._tree.all_file_ids()
734
 
        active_tree_ids = all_ids.difference(removed_tree_ids)
 
610
        active_tree_ids = set((f for f in self._tree.inventory if
 
611
                               f not in removed_tree_ids))
735
612
        for trans_id, file_id in self._new_id.iteritems():
736
613
            if file_id in active_tree_ids:
737
614
                old_trans_id = self.trans_id_tree_file_id(file_id)
739
616
        return conflicts
740
617
 
741
618
    def _parent_type_conflicts(self, by_parent):
742
 
        """Children must have a directory parent"""
 
619
        """parents must have directory 'contents'."""
743
620
        conflicts = []
744
621
        for parent_id, children in by_parent.iteritems():
745
622
            if parent_id is ROOT_PARENT:
746
623
                continue
747
 
            no_children = True
748
 
            for child_id in children:
749
 
                if self.final_kind(child_id) is not None:
750
 
                    no_children = False
751
 
                    break
752
 
            if no_children:
 
624
            if not self._any_contents(children):
753
625
                continue
754
 
            # There is at least a child, so we need an existing directory to
755
 
            # contain it.
756
 
            kind = self.final_kind(parent_id)
 
626
            for child in children:
 
627
                try:
 
628
                    self.final_kind(child)
 
629
                except NoSuchFile:
 
630
                    continue
 
631
            try:
 
632
                kind = self.final_kind(parent_id)
 
633
            except NoSuchFile:
 
634
                kind = None
757
635
            if kind is None:
758
 
                # The directory will be deleted
759
636
                conflicts.append(('missing parent', parent_id))
760
637
            elif kind != "directory":
761
 
                # Meh, we need a *directory* to put something in it
762
638
                conflicts.append(('non-directory parent', parent_id))
763
639
        return conflicts
764
640
 
765
 
    def _set_executability(self, path, trans_id):
 
641
    def _any_contents(self, trans_ids):
 
642
        """Return true if any of the trans_ids, will have contents."""
 
643
        for trans_id in trans_ids:
 
644
            try:
 
645
                kind = self.final_kind(trans_id)
 
646
            except NoSuchFile:
 
647
                continue
 
648
            return True
 
649
        return False
 
650
            
 
651
    def apply(self):
 
652
        """Apply all changes to the inventory and filesystem.
 
653
        
 
654
        If filesystem or inventory conflicts are present, MalformedTransform
 
655
        will be thrown.
 
656
        """
 
657
        conflicts = self.find_conflicts()
 
658
        if len(conflicts) != 0:
 
659
            raise MalformedTransform(conflicts=conflicts)
 
660
        limbo_inv = {}
 
661
        inv = self._tree.inventory
 
662
        self._apply_removals(inv, limbo_inv)
 
663
        self._apply_insertions(inv, limbo_inv)
 
664
        self._tree._write_inventory(inv)
 
665
        self.__done = True
 
666
        self.finalize()
 
667
 
 
668
    def _limbo_name(self, trans_id):
 
669
        """Generate the limbo name of a file"""
 
670
        return pathjoin(self._limbodir, trans_id)
 
671
 
 
672
    def _apply_removals(self, inv, limbo_inv):
 
673
        """Perform tree operations that remove directory/inventory names.
 
674
        
 
675
        That is, delete files that are to be deleted, and put any files that
 
676
        need renaming into limbo.  This must be done in strict child-to-parent
 
677
        order.
 
678
        """
 
679
        tree_paths = list(self._tree_path_ids.iteritems())
 
680
        tree_paths.sort(reverse=True)
 
681
        for num, data in enumerate(tree_paths):
 
682
            path, trans_id = data
 
683
            self._pb.update('removing file', num+1, len(tree_paths))
 
684
            full_path = self._tree.abspath(path)
 
685
            if trans_id in self._removed_contents:
 
686
                self.delete_any(full_path)
 
687
            elif trans_id in self._new_name or trans_id in self._new_parent:
 
688
                try:
 
689
                    os.rename(full_path, self._limbo_name(trans_id))
 
690
                except OSError, e:
 
691
                    if e.errno != errno.ENOENT:
 
692
                        raise
 
693
            if trans_id in self._removed_id:
 
694
                if trans_id == self._new_root:
 
695
                    file_id = self._tree.inventory.root.file_id
 
696
                else:
 
697
                    file_id = self.tree_file_id(trans_id)
 
698
                del inv[file_id]
 
699
            elif trans_id in self._new_name or trans_id in self._new_parent:
 
700
                file_id = self.tree_file_id(trans_id)
 
701
                if file_id is not None:
 
702
                    limbo_inv[trans_id] = inv[file_id]
 
703
                    del inv[file_id]
 
704
        self._pb.clear()
 
705
 
 
706
    def _apply_insertions(self, inv, limbo_inv):
 
707
        """Perform tree operations that insert directory/inventory names.
 
708
        
 
709
        That is, create any files that need to be created, and restore from
 
710
        limbo any files that needed renaming.  This must be done in strict
 
711
        parent-to-child order.
 
712
        """
 
713
        new_paths = self.new_paths()
 
714
        for num, (path, trans_id) in enumerate(new_paths):
 
715
            self._pb.update('adding file', num+1, len(new_paths))
 
716
            try:
 
717
                kind = self._new_contents[trans_id]
 
718
            except KeyError:
 
719
                kind = contents = None
 
720
            if trans_id in self._new_contents or self.path_changed(trans_id):
 
721
                full_path = self._tree.abspath(path)
 
722
                try:
 
723
                    os.rename(self._limbo_name(trans_id), full_path)
 
724
                except OSError, e:
 
725
                    # We may be renaming a dangling inventory id
 
726
                    if e.errno != errno.ENOENT:
 
727
                        raise
 
728
                if trans_id in self._new_contents:
 
729
                    del self._new_contents[trans_id]
 
730
 
 
731
            if trans_id in self._new_id:
 
732
                if kind is None:
 
733
                    kind = file_kind(self._tree.abspath(path))
 
734
                inv.add_path(path, kind, self._new_id[trans_id])
 
735
            elif trans_id in self._new_name or trans_id in self._new_parent:
 
736
                entry = limbo_inv.get(trans_id)
 
737
                if entry is not None:
 
738
                    entry.name = self.final_name(trans_id)
 
739
                    parent_path = os.path.dirname(path)
 
740
                    entry.parent_id = self._tree.inventory.path2id(parent_path)
 
741
                    inv.add(entry)
 
742
 
 
743
            # requires files and inventory entries to be in place
 
744
            if trans_id in self._new_executability:
 
745
                self._set_executability(path, inv, trans_id)
 
746
        self._pb.clear()
 
747
 
 
748
    def _set_executability(self, path, inv, trans_id):
766
749
        """Set the executability of versioned files """
 
750
        file_id = inv.path2id(path)
 
751
        new_executability = self._new_executability[trans_id]
 
752
        inv[file_id].executable = new_executability
767
753
        if supports_executable():
768
 
            new_executability = self._new_executability[trans_id]
769
754
            abspath = self._tree.abspath(path)
770
755
            current_mode = os.stat(abspath).st_mode
771
756
            if new_executability:
788
773
            self.version_file(file_id, trans_id)
789
774
        return trans_id
790
775
 
791
 
    def new_file(self, name, parent_id, contents, file_id=None,
792
 
                 executable=None, sha1=None):
 
776
    def new_file(self, name, parent_id, contents, file_id=None, 
 
777
                 executable=None):
793
778
        """Convenience method to create files.
794
 
 
 
779
        
795
780
        name is the name of the file to create.
796
781
        parent_id is the transaction id of the parent directory of the file.
797
782
        contents is an iterator of bytestrings, which will be used to produce
798
783
        the file.
799
 
        :param file_id: The inventory ID of the file, if it is to be versioned.
800
 
        :param executable: Only valid when a file_id has been supplied.
 
784
        file_id is the inventory ID of the file, if it is to be versioned.
801
785
        """
802
786
        trans_id = self._new_entry(name, parent_id, file_id)
803
 
        # TODO: rather than scheduling a set_executable call,
804
 
        # have create_file create the file with the right mode.
805
 
        self.create_file(contents, trans_id, sha1=sha1)
 
787
        self.create_file(contents, trans_id)
806
788
        if executable is not None:
807
789
            self.set_executability(executable, trans_id)
808
790
        return trans_id
817
799
        """
818
800
        trans_id = self._new_entry(name, parent_id, file_id)
819
801
        self.create_directory(trans_id)
820
 
        return trans_id
 
802
        return trans_id 
821
803
 
822
804
    def new_symlink(self, name, parent_id, target, file_id=None):
823
805
        """Convenience method to create symbolic link.
824
 
 
 
806
        
825
807
        name is the name of the symlink to create.
826
808
        parent_id is the transaction id of the parent directory of the symlink.
827
809
        target is a bytestring of the target of the symlink.
831
813
        self.create_symlink(target, trans_id)
832
814
        return trans_id
833
815
 
834
 
    def new_orphan(self, trans_id, parent_id):
835
 
        """Schedule an item to be orphaned.
836
 
 
837
 
        When a directory is about to be removed, its children, if they are not
838
 
        versioned are moved out of the way: they don't have a parent anymore.
839
 
 
840
 
        :param trans_id: The trans_id of the existing item.
841
 
        :param parent_id: The parent trans_id of the item.
842
 
        """
843
 
        raise NotImplementedError(self.new_orphan)
844
 
 
845
 
    def _get_potential_orphans(self, dir_id):
846
 
        """Find the potential orphans in a directory.
847
 
 
848
 
        A directory can't be safely deleted if there are versioned files in it.
849
 
        If all the contained files are unversioned then they can be orphaned.
850
 
 
851
 
        The 'None' return value means that the directory contains at least one
852
 
        versioned file and should not be deleted.
853
 
 
854
 
        :param dir_id: The directory trans id.
855
 
 
856
 
        :return: A list of the orphan trans ids or None if at least one
857
 
             versioned file is present.
858
 
        """
859
 
        orphans = []
860
 
        # Find the potential orphans, stop if one item should be kept
861
 
        for child_tid in self.by_parent()[dir_id]:
862
 
            if child_tid in self._removed_contents:
863
 
                # The child is removed as part of the transform. Since it was
864
 
                # versioned before, it's not an orphan
865
 
                continue
866
 
            elif self.final_file_id(child_tid) is None:
867
 
                # The child is not versioned
868
 
                orphans.append(child_tid)
869
 
            else:
870
 
                # We have a versioned file here, searching for orphans is
871
 
                # meaningless.
872
 
                orphans = None
873
 
                break
874
 
        return orphans
875
 
 
876
 
    def _affected_ids(self):
877
 
        """Return the set of transform ids affected by the transform"""
878
 
        trans_ids = set(self._removed_id)
879
 
        trans_ids.update(self._new_id.keys())
880
 
        trans_ids.update(self._removed_contents)
881
 
        trans_ids.update(self._new_contents.keys())
882
 
        trans_ids.update(self._new_executability.keys())
883
 
        trans_ids.update(self._new_name.keys())
884
 
        trans_ids.update(self._new_parent.keys())
885
 
        return trans_ids
886
 
 
887
 
    def _get_file_id_maps(self):
888
 
        """Return mapping of file_ids to trans_ids in the to and from states"""
889
 
        trans_ids = self._affected_ids()
890
 
        from_trans_ids = {}
891
 
        to_trans_ids = {}
892
 
        # Build up two dicts: trans_ids associated with file ids in the
893
 
        # FROM state, vs the TO state.
894
 
        for trans_id in trans_ids:
895
 
            from_file_id = self.tree_file_id(trans_id)
896
 
            if from_file_id is not None:
897
 
                from_trans_ids[from_file_id] = trans_id
898
 
            to_file_id = self.final_file_id(trans_id)
899
 
            if to_file_id is not None:
900
 
                to_trans_ids[to_file_id] = trans_id
901
 
        return from_trans_ids, to_trans_ids
902
 
 
903
 
    def _from_file_data(self, from_trans_id, from_versioned, file_id):
904
 
        """Get data about a file in the from (tree) state
905
 
 
906
 
        Return a (name, parent, kind, executable) tuple
907
 
        """
908
 
        from_path = self._tree_id_paths.get(from_trans_id)
909
 
        if from_versioned:
910
 
            # get data from working tree if versioned
911
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
912
 
            from_name = from_entry.name
913
 
            from_parent = from_entry.parent_id
914
 
        else:
915
 
            from_entry = None
916
 
            if from_path is None:
917
 
                # File does not exist in FROM state
918
 
                from_name = None
919
 
                from_parent = None
920
 
            else:
921
 
                # File exists, but is not versioned.  Have to use path-
922
 
                # splitting stuff
923
 
                from_name = os.path.basename(from_path)
924
 
                tree_parent = self.get_tree_parent(from_trans_id)
925
 
                from_parent = self.tree_file_id(tree_parent)
926
 
        if from_path is not None:
927
 
            from_kind, from_executable, from_stats = \
928
 
                self._tree._comparison_data(from_entry, from_path)
929
 
        else:
930
 
            from_kind = None
931
 
            from_executable = False
932
 
        return from_name, from_parent, from_kind, from_executable
933
 
 
934
 
    def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
935
 
        """Get data about a file in the to (target) state
936
 
 
937
 
        Return a (name, parent, kind, executable) tuple
938
 
        """
939
 
        to_name = self.final_name(to_trans_id)
940
 
        to_kind = self.final_kind(to_trans_id)
941
 
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
942
 
        if to_trans_id in self._new_executability:
943
 
            to_executable = self._new_executability[to_trans_id]
944
 
        elif to_trans_id == from_trans_id:
945
 
            to_executable = from_executable
946
 
        else:
947
 
            to_executable = False
948
 
        return to_name, to_parent, to_kind, to_executable
949
 
 
950
 
    def iter_changes(self):
951
 
        """Produce output in the same format as Tree.iter_changes.
952
 
 
953
 
        Will produce nonsensical results if invoked while inventory/filesystem
954
 
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
955
 
 
956
 
        This reads the Transform, but only reproduces changes involving a
957
 
        file_id.  Files that are not versioned in either of the FROM or TO
958
 
        states are not reflected.
959
 
        """
960
 
        final_paths = FinalPaths(self)
961
 
        from_trans_ids, to_trans_ids = self._get_file_id_maps()
962
 
        results = []
963
 
        # Now iterate through all active file_ids
964
 
        for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
965
 
            modified = False
966
 
            from_trans_id = from_trans_ids.get(file_id)
967
 
            # find file ids, and determine versioning state
968
 
            if from_trans_id is None:
969
 
                from_versioned = False
970
 
                from_trans_id = to_trans_ids[file_id]
971
 
            else:
972
 
                from_versioned = True
973
 
            to_trans_id = to_trans_ids.get(file_id)
974
 
            if to_trans_id is None:
975
 
                to_versioned = False
976
 
                to_trans_id = from_trans_id
977
 
            else:
978
 
                to_versioned = True
979
 
 
980
 
            from_name, from_parent, from_kind, from_executable = \
981
 
                self._from_file_data(from_trans_id, from_versioned, file_id)
982
 
 
983
 
            to_name, to_parent, to_kind, to_executable = \
984
 
                self._to_file_data(to_trans_id, from_trans_id, from_executable)
985
 
 
986
 
            if not from_versioned:
987
 
                from_path = None
988
 
            else:
989
 
                from_path = self._tree_id_paths.get(from_trans_id)
990
 
            if not to_versioned:
991
 
                to_path = None
992
 
            else:
993
 
                to_path = final_paths.get_path(to_trans_id)
994
 
            if from_kind != to_kind:
995
 
                modified = True
996
 
            elif to_kind in ('file', 'symlink') and (
997
 
                to_trans_id != from_trans_id or
998
 
                to_trans_id in self._new_contents):
999
 
                modified = True
1000
 
            if (not modified and from_versioned == to_versioned and
1001
 
                from_parent==to_parent and from_name == to_name and
1002
 
                from_executable == to_executable):
1003
 
                continue
1004
 
            results.append((file_id, (from_path, to_path), modified,
1005
 
                   (from_versioned, to_versioned),
1006
 
                   (from_parent, to_parent),
1007
 
                   (from_name, to_name),
1008
 
                   (from_kind, to_kind),
1009
 
                   (from_executable, to_executable)))
1010
 
        return iter(sorted(results, key=lambda x:x[1]))
1011
 
 
1012
 
    def get_preview_tree(self):
1013
 
        """Return a tree representing the result of the transform.
1014
 
 
1015
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
1016
 
        it.
1017
 
        """
1018
 
        return _PreviewTree(self)
1019
 
 
1020
 
    def commit(self, branch, message, merge_parents=None, strict=False,
1021
 
               timestamp=None, timezone=None, committer=None, authors=None,
1022
 
               revprops=None, revision_id=None):
1023
 
        """Commit the result of this TreeTransform to a branch.
1024
 
 
1025
 
        :param branch: The branch to commit to.
1026
 
        :param message: The message to attach to the commit.
1027
 
        :param merge_parents: Additional parent revision-ids specified by
1028
 
            pending merges.
1029
 
        :param strict: If True, abort the commit if there are unversioned
1030
 
            files.
1031
 
        :param timestamp: if not None, seconds-since-epoch for the time and
1032
 
            date.  (May be a float.)
1033
 
        :param timezone: Optional timezone for timestamp, as an offset in
1034
 
            seconds.
1035
 
        :param committer: Optional committer in email-id format.
1036
 
            (e.g. "J Random Hacker <jrandom@example.com>")
1037
 
        :param authors: Optional list of authors in email-id format.
1038
 
        :param revprops: Optional dictionary of revision properties.
1039
 
        :param revision_id: Optional revision id.  (Specifying a revision-id
1040
 
            may reduce performance for some non-native formats.)
1041
 
        :return: The revision_id of the revision committed.
1042
 
        """
1043
 
        self._check_malformed()
1044
 
        if strict:
1045
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
1046
 
            for trans_id in unversioned:
1047
 
                if self.final_file_id(trans_id) is None:
1048
 
                    raise errors.StrictCommitFailed()
1049
 
 
1050
 
        revno, last_rev_id = branch.last_revision_info()
1051
 
        if last_rev_id == _mod_revision.NULL_REVISION:
1052
 
            if merge_parents is not None:
1053
 
                raise ValueError('Cannot supply merge parents for first'
1054
 
                                 ' commit.')
1055
 
            parent_ids = []
1056
 
        else:
1057
 
            parent_ids = [last_rev_id]
1058
 
            if merge_parents is not None:
1059
 
                parent_ids.extend(merge_parents)
1060
 
        if self._tree.get_revision_id() != last_rev_id:
1061
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
1062
 
                             self._tree.get_revision_id())
1063
 
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
1064
 
        builder = branch.get_commit_builder(parent_ids,
1065
 
                                            timestamp=timestamp,
1066
 
                                            timezone=timezone,
1067
 
                                            committer=committer,
1068
 
                                            revprops=revprops,
1069
 
                                            revision_id=revision_id)
1070
 
        preview = self.get_preview_tree()
1071
 
        list(builder.record_iter_changes(preview, last_rev_id,
1072
 
                                         self.iter_changes()))
1073
 
        builder.finish_inventory()
1074
 
        revision_id = builder.commit(message)
1075
 
        branch.set_last_revision_info(revno + 1, revision_id)
1076
 
        return revision_id
1077
 
 
1078
 
    def _text_parent(self, trans_id):
1079
 
        file_id = self.tree_file_id(trans_id)
1080
 
        try:
1081
 
            if file_id is None or self._tree.kind(file_id) != 'file':
1082
 
                return None
1083
 
        except errors.NoSuchFile:
1084
 
            return None
1085
 
        return file_id
1086
 
 
1087
 
    def _get_parents_texts(self, trans_id):
1088
 
        """Get texts for compression parents of this file."""
1089
 
        file_id = self._text_parent(trans_id)
1090
 
        if file_id is None:
1091
 
            return ()
1092
 
        return (self._tree.get_file_text(file_id),)
1093
 
 
1094
 
    def _get_parents_lines(self, trans_id):
1095
 
        """Get lines for compression parents of this file."""
1096
 
        file_id = self._text_parent(trans_id)
1097
 
        if file_id is None:
1098
 
            return ()
1099
 
        return (self._tree.get_file_lines(file_id),)
1100
 
 
1101
 
    def serialize(self, serializer):
1102
 
        """Serialize this TreeTransform.
1103
 
 
1104
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
1105
 
        """
1106
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
1107
 
                        self._new_name.items())
1108
 
        new_executability = dict((k, int(v)) for k, v in
1109
 
                                 self._new_executability.items())
1110
 
        tree_path_ids = dict((k.encode('utf-8'), v)
1111
 
                             for k, v in self._tree_path_ids.items())
1112
 
        attribs = {
1113
 
            '_id_number': self._id_number,
1114
 
            '_new_name': new_name,
1115
 
            '_new_parent': self._new_parent,
1116
 
            '_new_executability': new_executability,
1117
 
            '_new_id': self._new_id,
1118
 
            '_tree_path_ids': tree_path_ids,
1119
 
            '_removed_id': list(self._removed_id),
1120
 
            '_removed_contents': list(self._removed_contents),
1121
 
            '_non_present_ids': self._non_present_ids,
1122
 
            }
1123
 
        yield serializer.bytes_record(bencode.bencode(attribs),
1124
 
                                      (('attribs',),))
1125
 
        for trans_id, kind in self._new_contents.items():
1126
 
            if kind == 'file':
1127
 
                lines = osutils.chunks_to_lines(
1128
 
                    self._read_file_chunks(trans_id))
1129
 
                parents = self._get_parents_lines(trans_id)
1130
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1131
 
                content = ''.join(mpdiff.to_patch())
1132
 
            if kind == 'directory':
1133
 
                content = ''
1134
 
            if kind == 'symlink':
1135
 
                content = self._read_symlink_target(trans_id)
1136
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
1137
 
 
1138
 
    def deserialize(self, records):
1139
 
        """Deserialize a stored TreeTransform.
1140
 
 
1141
 
        :param records: An iterable of (names, content) tuples, as per
1142
 
            pack.ContainerPushParser.
1143
 
        """
1144
 
        names, content = records.next()
1145
 
        attribs = bencode.bdecode(content)
1146
 
        self._id_number = attribs['_id_number']
1147
 
        self._new_name = dict((k, v.decode('utf-8'))
1148
 
                            for k, v in attribs['_new_name'].items())
1149
 
        self._new_parent = attribs['_new_parent']
1150
 
        self._new_executability = dict((k, bool(v)) for k, v in
1151
 
            attribs['_new_executability'].items())
1152
 
        self._new_id = attribs['_new_id']
1153
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1154
 
        self._tree_path_ids = {}
1155
 
        self._tree_id_paths = {}
1156
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
1157
 
            path = bytepath.decode('utf-8')
1158
 
            self._tree_path_ids[path] = trans_id
1159
 
            self._tree_id_paths[trans_id] = path
1160
 
        self._removed_id = set(attribs['_removed_id'])
1161
 
        self._removed_contents = set(attribs['_removed_contents'])
1162
 
        self._non_present_ids = attribs['_non_present_ids']
1163
 
        for ((trans_id, kind),), content in records:
1164
 
            if kind == 'file':
1165
 
                mpdiff = multiparent.MultiParent.from_patch(content)
1166
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1167
 
                self.create_file(lines, trans_id)
1168
 
            if kind == 'directory':
1169
 
                self.create_directory(trans_id)
1170
 
            if kind == 'symlink':
1171
 
                self.create_symlink(content.decode('utf-8'), trans_id)
1172
 
 
1173
 
 
1174
 
class DiskTreeTransform(TreeTransformBase):
1175
 
    """Tree transform storing its contents on disk."""
1176
 
 
1177
 
    def __init__(self, tree, limbodir, pb=None,
1178
 
                 case_sensitive=True):
1179
 
        """Constructor.
1180
 
        :param tree: The tree that will be transformed, but not necessarily
1181
 
            the output tree.
1182
 
        :param limbodir: A directory where new files can be stored until
1183
 
            they are installed in their proper places
1184
 
        :param pb: ignored
1185
 
        :param case_sensitive: If True, the target of the transform is
1186
 
            case sensitive, not just case preserving.
1187
 
        """
1188
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1189
 
        self._limbodir = limbodir
1190
 
        self._deletiondir = None
1191
 
        # A mapping of transform ids to their limbo filename
1192
 
        self._limbo_files = {}
1193
 
        self._possibly_stale_limbo_files = set()
1194
 
        # A mapping of transform ids to a set of the transform ids of children
1195
 
        # that their limbo directory has
1196
 
        self._limbo_children = {}
1197
 
        # Map transform ids to maps of child filename to child transform id
1198
 
        self._limbo_children_names = {}
1199
 
        # List of transform ids that need to be renamed from limbo into place
1200
 
        self._needs_rename = set()
1201
 
        self._creation_mtime = None
1202
 
 
1203
 
    def finalize(self):
1204
 
        """Release the working tree lock, if held, clean up limbo dir.
1205
 
 
1206
 
        This is required if apply has not been invoked, but can be invoked
1207
 
        even after apply.
1208
 
        """
1209
 
        if self._tree is None:
1210
 
            return
1211
 
        try:
1212
 
            limbo_paths = self._limbo_files.values() + list(
1213
 
                self._possibly_stale_limbo_files)
1214
 
            limbo_paths = sorted(limbo_paths, reverse=True)
1215
 
            for path in limbo_paths:
1216
 
                try:
1217
 
                    delete_any(path)
1218
 
                except OSError, e:
1219
 
                    if e.errno != errno.ENOENT:
1220
 
                        raise
1221
 
                    # XXX: warn? perhaps we just got interrupted at an
1222
 
                    # inconvenient moment, but perhaps files are disappearing
1223
 
                    # from under us?
1224
 
            try:
1225
 
                delete_any(self._limbodir)
1226
 
            except OSError:
1227
 
                # We don't especially care *why* the dir is immortal.
1228
 
                raise ImmortalLimbo(self._limbodir)
1229
 
            try:
1230
 
                if self._deletiondir is not None:
1231
 
                    delete_any(self._deletiondir)
1232
 
            except OSError:
1233
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1234
 
        finally:
1235
 
            TreeTransformBase.finalize(self)
1236
 
 
1237
 
    def _limbo_name(self, trans_id):
1238
 
        """Generate the limbo name of a file"""
1239
 
        limbo_name = self._limbo_files.get(trans_id)
1240
 
        if limbo_name is None:
1241
 
            limbo_name = self._generate_limbo_path(trans_id)
1242
 
            self._limbo_files[trans_id] = limbo_name
1243
 
        return limbo_name
1244
 
 
1245
 
    def _generate_limbo_path(self, trans_id):
1246
 
        """Generate a limbo path using the trans_id as the relative path.
1247
 
 
1248
 
        This is suitable as a fallback, and when the transform should not be
1249
 
        sensitive to the path encoding of the limbo directory.
1250
 
        """
1251
 
        self._needs_rename.add(trans_id)
1252
 
        return pathjoin(self._limbodir, trans_id)
1253
 
 
1254
 
    def adjust_path(self, name, parent, trans_id):
1255
 
        previous_parent = self._new_parent.get(trans_id)
1256
 
        previous_name = self._new_name.get(trans_id)
1257
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1258
 
        if (trans_id in self._limbo_files and
1259
 
            trans_id not in self._needs_rename):
1260
 
            self._rename_in_limbo([trans_id])
1261
 
            if previous_parent != parent:
1262
 
                self._limbo_children[previous_parent].remove(trans_id)
1263
 
            if previous_parent != parent or previous_name != name:
1264
 
                del self._limbo_children_names[previous_parent][previous_name]
1265
 
 
1266
 
    def _rename_in_limbo(self, trans_ids):
1267
 
        """Fix limbo names so that the right final path is produced.
1268
 
 
1269
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1270
 
        these files later by creating them with their final names in their
1271
 
        final parents.  But now the previous name or parent is no longer
1272
 
        suitable, so we have to rename them.
1273
 
 
1274
 
        Even for trans_ids that have no new contents, we must remove their
1275
 
        entries from _limbo_files, because they are now stale.
1276
 
        """
1277
 
        for trans_id in trans_ids:
1278
 
            old_path = self._limbo_files[trans_id]
1279
 
            self._possibly_stale_limbo_files.add(old_path)
1280
 
            del self._limbo_files[trans_id]
1281
 
            if trans_id not in self._new_contents:
1282
 
                continue
1283
 
            new_path = self._limbo_name(trans_id)
1284
 
            os.rename(old_path, new_path)
1285
 
            self._possibly_stale_limbo_files.remove(old_path)
1286
 
            for descendant in self._limbo_descendants(trans_id):
1287
 
                desc_path = self._limbo_files[descendant]
1288
 
                desc_path = new_path + desc_path[len(old_path):]
1289
 
                self._limbo_files[descendant] = desc_path
1290
 
 
1291
 
    def _limbo_descendants(self, trans_id):
1292
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1293
 
        descendants = set(self._limbo_children.get(trans_id, []))
1294
 
        for descendant in list(descendants):
1295
 
            descendants.update(self._limbo_descendants(descendant))
1296
 
        return descendants
1297
 
 
1298
 
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1299
 
        """Schedule creation of a new file.
1300
 
 
1301
 
        :seealso: new_file.
1302
 
 
1303
 
        :param contents: an iterator of strings, all of which will be written
1304
 
            to the target destination.
1305
 
        :param trans_id: TreeTransform handle
1306
 
        :param mode_id: If not None, force the mode of the target file to match
1307
 
            the mode of the object referenced by mode_id.
1308
 
            Otherwise, we will try to preserve mode bits of an existing file.
1309
 
        :param sha1: If the sha1 of this content is already known, pass it in.
1310
 
            We can use it to prevent future sha1 computations.
1311
 
        """
1312
 
        name = self._limbo_name(trans_id)
1313
 
        f = open(name, 'wb')
1314
 
        try:
1315
 
            unique_add(self._new_contents, trans_id, 'file')
1316
 
            f.writelines(contents)
1317
 
        finally:
1318
 
            f.close()
1319
 
        self._set_mtime(name)
1320
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1321
 
        # It is unfortunate we have to use lstat instead of fstat, but we just
1322
 
        # used utime and chmod on the file, so we need the accurate final
1323
 
        # details.
1324
 
        if sha1 is not None:
1325
 
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1326
 
 
1327
 
    def _read_file_chunks(self, trans_id):
1328
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1329
 
        try:
1330
 
            return cur_file.readlines()
1331
 
        finally:
1332
 
            cur_file.close()
1333
 
 
1334
 
    def _read_symlink_target(self, trans_id):
1335
 
        return os.readlink(self._limbo_name(trans_id))
1336
 
 
1337
 
    def _set_mtime(self, path):
1338
 
        """All files that are created get the same mtime.
1339
 
 
1340
 
        This time is set by the first object to be created.
1341
 
        """
1342
 
        if self._creation_mtime is None:
1343
 
            self._creation_mtime = time.time()
1344
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1345
 
 
1346
 
    def create_hardlink(self, path, trans_id):
1347
 
        """Schedule creation of a hard link"""
1348
 
        name = self._limbo_name(trans_id)
1349
 
        try:
1350
 
            os.link(path, name)
1351
 
        except OSError, e:
1352
 
            if e.errno != errno.EPERM:
1353
 
                raise
1354
 
            raise errors.HardLinkNotSupported(path)
1355
 
        try:
1356
 
            unique_add(self._new_contents, trans_id, 'file')
1357
 
        except:
1358
 
            # Clean up the file, it never got registered so
1359
 
            # TreeTransform.finalize() won't clean it up.
1360
 
            os.unlink(name)
1361
 
            raise
1362
 
 
1363
 
    def create_directory(self, trans_id):
1364
 
        """Schedule creation of a new directory.
1365
 
 
1366
 
        See also new_directory.
1367
 
        """
1368
 
        os.mkdir(self._limbo_name(trans_id))
1369
 
        unique_add(self._new_contents, trans_id, 'directory')
1370
 
 
1371
 
    def create_symlink(self, target, trans_id):
1372
 
        """Schedule creation of a new symbolic link.
1373
 
 
1374
 
        target is a bytestring.
1375
 
        See also new_symlink.
1376
 
        """
1377
 
        if has_symlinks():
1378
 
            os.symlink(target, self._limbo_name(trans_id))
1379
 
            unique_add(self._new_contents, trans_id, 'symlink')
1380
 
        else:
1381
 
            try:
1382
 
                path = FinalPaths(self).get_path(trans_id)
1383
 
            except KeyError:
1384
 
                path = None
1385
 
            raise UnableCreateSymlink(path=path)
1386
 
 
1387
 
    def cancel_creation(self, trans_id):
1388
 
        """Cancel the creation of new file contents."""
1389
 
        del self._new_contents[trans_id]
1390
 
        if trans_id in self._observed_sha1s:
1391
 
            del self._observed_sha1s[trans_id]
1392
 
        children = self._limbo_children.get(trans_id)
1393
 
        # if this is a limbo directory with children, move them before removing
1394
 
        # the directory
1395
 
        if children is not None:
1396
 
            self._rename_in_limbo(children)
1397
 
            del self._limbo_children[trans_id]
1398
 
            del self._limbo_children_names[trans_id]
1399
 
        delete_any(self._limbo_name(trans_id))
1400
 
 
1401
 
    def new_orphan(self, trans_id, parent_id):
1402
 
        # FIXME: There is no tree config, so we use the branch one (it's weird
1403
 
        # to define it this way as orphaning can only occur in a working tree,
1404
 
        # but that's all we have (for now). It will find the option in
1405
 
        # locations.conf or bazaar.conf though) -- vila 20100916
1406
 
        conf = self._tree.branch.get_config()
1407
 
        conf_var_name = 'bzr.transform.orphan_policy'
1408
 
        orphan_policy = conf.get_user_option(conf_var_name)
1409
 
        default_policy = orphaning_registry.default_key
1410
 
        if orphan_policy is None:
1411
 
            orphan_policy = default_policy
1412
 
        if orphan_policy not in orphaning_registry:
1413
 
            trace.warning('%s (from %s) is not a known policy, defaulting '
1414
 
                'to %s' % (orphan_policy, conf_var_name, default_policy))
1415
 
            orphan_policy = default_policy
1416
 
        handle_orphan = orphaning_registry.get(orphan_policy)
1417
 
        handle_orphan(self, trans_id, parent_id)
1418
 
 
1419
 
 
1420
 
class OrphaningError(errors.BzrError):
1421
 
 
1422
 
    # Only bugs could lead to such exception being seen by the user
1423
 
    internal_error = True
1424
 
    _fmt = "Error while orphaning %s in %s directory"
1425
 
 
1426
 
    def __init__(self, orphan, parent):
1427
 
        errors.BzrError.__init__(self)
1428
 
        self.orphan = orphan
1429
 
        self.parent = parent
1430
 
 
1431
 
 
1432
 
class OrphaningForbidden(OrphaningError):
1433
 
 
1434
 
    _fmt = "Policy: %s doesn't allow creating orphans."
1435
 
 
1436
 
    def __init__(self, policy):
1437
 
        errors.BzrError.__init__(self)
1438
 
        self.policy = policy
1439
 
 
1440
 
 
1441
 
def move_orphan(tt, orphan_id, parent_id):
1442
 
    """See TreeTransformBase.new_orphan.
1443
 
 
1444
 
    This creates a new orphan in the `bzr-orphans` dir at the root of the
1445
 
    `TreeTransform`.
1446
 
 
1447
 
    :param tt: The TreeTransform orphaning `trans_id`.
1448
 
 
1449
 
    :param orphan_id: The trans id that should be orphaned.
1450
 
 
1451
 
    :param parent_id: The orphan parent trans id.
1452
 
    """
1453
 
    # Add the orphan dir if it doesn't exist
1454
 
    orphan_dir_basename = 'bzr-orphans'
1455
 
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
1456
 
    if tt.final_kind(od_id) is None:
1457
 
        tt.create_directory(od_id)
1458
 
    parent_path = tt._tree_id_paths[parent_id]
1459
 
    # Find a name that doesn't exist yet in the orphan dir
1460
 
    actual_name = tt.final_name(orphan_id)
1461
 
    new_name = tt._available_backup_name(actual_name, od_id)
1462
 
    tt.adjust_path(new_name, od_id, orphan_id)
1463
 
    trace.warning('%s has been orphaned in %s'
1464
 
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
1465
 
 
1466
 
 
1467
 
def refuse_orphan(tt, orphan_id, parent_id):
1468
 
    """See TreeTransformBase.new_orphan.
1469
 
 
1470
 
    This refuses to create orphan, letting the caller handle the conflict.
1471
 
    """
1472
 
    raise OrphaningForbidden('never')
1473
 
 
1474
 
 
1475
 
orphaning_registry = registry.Registry()
1476
 
orphaning_registry.register(
1477
 
    'conflict', refuse_orphan,
1478
 
    'Leave orphans in place and create a conflict on the directory.')
1479
 
orphaning_registry.register(
1480
 
    'move', move_orphan,
1481
 
    'Move orphans into the bzr-orphans directory.')
1482
 
orphaning_registry._set_default_key('conflict')
1483
 
 
1484
 
 
1485
 
class TreeTransform(DiskTreeTransform):
1486
 
    """Represent a tree transformation.
1487
 
 
1488
 
    This object is designed to support incremental generation of the transform,
1489
 
    in any order.
1490
 
 
1491
 
    However, it gives optimum performance when parent directories are created
1492
 
    before their contents.  The transform is then able to put child files
1493
 
    directly in their parent directory, avoiding later renames.
1494
 
 
1495
 
    It is easy to produce malformed transforms, but they are generally
1496
 
    harmless.  Attempting to apply a malformed transform will cause an
1497
 
    exception to be raised before any modifications are made to the tree.
1498
 
 
1499
 
    Many kinds of malformed transforms can be corrected with the
1500
 
    resolve_conflicts function.  The remaining ones indicate programming error,
1501
 
    such as trying to create a file with no path.
1502
 
 
1503
 
    Two sets of file creation methods are supplied.  Convenience methods are:
1504
 
     * new_file
1505
 
     * new_directory
1506
 
     * new_symlink
1507
 
 
1508
 
    These are composed of the low-level methods:
1509
 
     * create_path
1510
 
     * create_file or create_directory or create_symlink
1511
 
     * version_file
1512
 
     * set_executability
1513
 
 
1514
 
    Transform/Transaction ids
1515
 
    -------------------------
1516
 
    trans_ids are temporary ids assigned to all files involved in a transform.
1517
 
    It's possible, even common, that not all files in the Tree have trans_ids.
1518
 
 
1519
 
    trans_ids are used because filenames and file_ids are not good enough
1520
 
    identifiers; filenames change, and not all files have file_ids.  File-ids
1521
 
    are also associated with trans-ids, so that moving a file moves its
1522
 
    file-id.
1523
 
 
1524
 
    trans_ids are only valid for the TreeTransform that generated them.
1525
 
 
1526
 
    Limbo
1527
 
    -----
1528
 
    Limbo is a temporary directory use to hold new versions of files.
1529
 
    Files are added to limbo by create_file, create_directory, create_symlink,
1530
 
    and their convenience variants (new_*).  Files may be removed from limbo
1531
 
    using cancel_creation.  Files are renamed from limbo into their final
1532
 
    location as part of TreeTransform.apply
1533
 
 
1534
 
    Limbo must be cleaned up, by either calling TreeTransform.apply or
1535
 
    calling TreeTransform.finalize.
1536
 
 
1537
 
    Files are placed into limbo inside their parent directories, where
1538
 
    possible.  This reduces subsequent renames, and makes operations involving
1539
 
    lots of files faster.  This optimization is only possible if the parent
1540
 
    directory is created *before* creating any of its children, so avoid
1541
 
    creating children before parents, where possible.
1542
 
 
1543
 
    Pending-deletion
1544
 
    ----------------
1545
 
    This temporary directory is used by _FileMover for storing files that are
1546
 
    about to be deleted.  In case of rollback, the files will be restored.
1547
 
    FileMover does not delete files until it is sure that a rollback will not
1548
 
    happen.
1549
 
    """
1550
 
    def __init__(self, tree, pb=None):
1551
 
        """Note: a tree_write lock is taken on the tree.
1552
 
 
1553
 
        Use TreeTransform.finalize() to release the lock (can be omitted if
1554
 
        TreeTransform.apply() called).
1555
 
        """
1556
 
        tree.lock_tree_write()
1557
 
 
1558
 
        try:
1559
 
            limbodir = urlutils.local_path_from_url(
1560
 
                tree._transport.abspath('limbo'))
1561
 
            try:
1562
 
                os.mkdir(limbodir)
1563
 
            except OSError, e:
1564
 
                if e.errno == errno.EEXIST:
1565
 
                    raise ExistingLimbo(limbodir)
1566
 
            deletiondir = urlutils.local_path_from_url(
1567
 
                tree._transport.abspath('pending-deletion'))
1568
 
            try:
1569
 
                os.mkdir(deletiondir)
1570
 
            except OSError, e:
1571
 
                if e.errno == errno.EEXIST:
1572
 
                    raise errors.ExistingPendingDeletion(deletiondir)
1573
 
        except:
1574
 
            tree.unlock()
1575
 
            raise
1576
 
 
1577
 
        # Cache of realpath results, to speed up canonical_path
1578
 
        self._realpaths = {}
1579
 
        # Cache of relpath results, to speed up canonical_path
1580
 
        self._relpaths = {}
1581
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
1582
 
                                   tree.case_sensitive)
1583
 
        self._deletiondir = deletiondir
1584
 
 
1585
 
    def canonical_path(self, path):
1586
 
        """Get the canonical tree-relative path"""
1587
 
        # don't follow final symlinks
1588
 
        abs = self._tree.abspath(path)
1589
 
        if abs in self._relpaths:
1590
 
            return self._relpaths[abs]
1591
 
        dirname, basename = os.path.split(abs)
1592
 
        if dirname not in self._realpaths:
1593
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1594
 
        dirname = self._realpaths[dirname]
1595
 
        abs = pathjoin(dirname, basename)
1596
 
        if dirname in self._relpaths:
1597
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1598
 
            relpath = relpath.rstrip('/\\')
1599
 
        else:
1600
 
            relpath = self._tree.relpath(abs)
1601
 
        self._relpaths[abs] = relpath
1602
 
        return relpath
1603
 
 
1604
 
    def tree_kind(self, trans_id):
1605
 
        """Determine the file kind in the working tree.
1606
 
 
1607
 
        :returns: The file kind or None if the file does not exist
1608
 
        """
1609
 
        path = self._tree_id_paths.get(trans_id)
1610
 
        if path is None:
1611
 
            return None
1612
 
        try:
1613
 
            return file_kind(self._tree.abspath(path))
1614
 
        except errors.NoSuchFile:
1615
 
            return None
1616
 
 
1617
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1618
 
        """Set the mode of new file contents.
1619
 
        The mode_id is the existing file to get the mode from (often the same
1620
 
        as trans_id).  The operation is only performed if there's a mode match
1621
 
        according to typefunc.
1622
 
        """
1623
 
        if mode_id is None:
1624
 
            mode_id = trans_id
1625
 
        try:
1626
 
            old_path = self._tree_id_paths[mode_id]
1627
 
        except KeyError:
1628
 
            return
1629
 
        try:
1630
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1631
 
        except OSError, e:
1632
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1633
 
                # Either old_path doesn't exist, or the parent of the
1634
 
                # target is not a directory (but will be one eventually)
1635
 
                # Either way, we know it doesn't exist *right now*
1636
 
                # See also bug #248448
1637
 
                return
1638
 
            else:
1639
 
                raise
1640
 
        if typefunc(mode):
1641
 
            os.chmod(self._limbo_name(trans_id), mode)
1642
 
 
1643
 
    def iter_tree_children(self, parent_id):
1644
 
        """Iterate through the entry's tree children, if any"""
1645
 
        try:
1646
 
            path = self._tree_id_paths[parent_id]
1647
 
        except KeyError:
1648
 
            return
1649
 
        try:
1650
 
            children = os.listdir(self._tree.abspath(path))
1651
 
        except OSError, e:
1652
 
            if not (osutils._is_error_enotdir(e)
1653
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1654
 
                raise
1655
 
            return
1656
 
 
1657
 
        for child in children:
1658
 
            childpath = joinpath(path, child)
1659
 
            if self._tree.is_control_filename(childpath):
1660
 
                continue
1661
 
            yield self.trans_id_tree_path(childpath)
1662
 
 
1663
 
    def _generate_limbo_path(self, trans_id):
1664
 
        """Generate a limbo path using the final path if possible.
1665
 
 
1666
 
        This optimizes the performance of applying the tree transform by
1667
 
        avoiding renames.  These renames can be avoided only when the parent
1668
 
        directory is already scheduled for creation.
1669
 
 
1670
 
        If the final path cannot be used, falls back to using the trans_id as
1671
 
        the relpath.
1672
 
        """
1673
 
        parent = self._new_parent.get(trans_id)
1674
 
        # if the parent directory is already in limbo (e.g. when building a
1675
 
        # tree), choose a limbo name inside the parent, to reduce further
1676
 
        # renames.
1677
 
        use_direct_path = False
1678
 
        if self._new_contents.get(parent) == 'directory':
1679
 
            filename = self._new_name.get(trans_id)
1680
 
            if filename is not None:
1681
 
                if parent not in self._limbo_children:
1682
 
                    self._limbo_children[parent] = set()
1683
 
                    self._limbo_children_names[parent] = {}
1684
 
                    use_direct_path = True
1685
 
                # the direct path can only be used if no other file has
1686
 
                # already taken this pathname, i.e. if the name is unused, or
1687
 
                # if it is already associated with this trans_id.
1688
 
                elif self._case_sensitive_target:
1689
 
                    if (self._limbo_children_names[parent].get(filename)
1690
 
                        in (trans_id, None)):
1691
 
                        use_direct_path = True
1692
 
                else:
1693
 
                    for l_filename, l_trans_id in\
1694
 
                        self._limbo_children_names[parent].iteritems():
1695
 
                        if l_trans_id == trans_id:
1696
 
                            continue
1697
 
                        if l_filename.lower() == filename.lower():
1698
 
                            break
1699
 
                    else:
1700
 
                        use_direct_path = True
1701
 
 
1702
 
        if not use_direct_path:
1703
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1704
 
 
1705
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1706
 
        self._limbo_children[parent].add(trans_id)
1707
 
        self._limbo_children_names[parent][filename] = trans_id
1708
 
        return limbo_name
1709
 
 
1710
 
 
1711
 
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1712
 
        """Apply all changes to the inventory and filesystem.
1713
 
 
1714
 
        If filesystem or inventory conflicts are present, MalformedTransform
1715
 
        will be thrown.
1716
 
 
1717
 
        If apply succeeds, finalize is not necessary.
1718
 
 
1719
 
        :param no_conflicts: if True, the caller guarantees there are no
1720
 
            conflicts, so no check is made.
1721
 
        :param precomputed_delta: An inventory delta to use instead of
1722
 
            calculating one.
1723
 
        :param _mover: Supply an alternate FileMover, for testing
1724
 
        """
1725
 
        if not no_conflicts:
1726
 
            self._check_malformed()
1727
 
        child_pb = ui.ui_factory.nested_progress_bar()
1728
 
        try:
1729
 
            if precomputed_delta is None:
1730
 
                child_pb.update(gettext('Apply phase'), 0, 2)
1731
 
                inventory_delta = self._generate_inventory_delta()
1732
 
                offset = 1
1733
 
            else:
1734
 
                inventory_delta = precomputed_delta
1735
 
                offset = 0
1736
 
            if _mover is None:
1737
 
                mover = _FileMover()
1738
 
            else:
1739
 
                mover = _mover
1740
 
            try:
1741
 
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1742
 
                self._apply_removals(mover)
1743
 
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1744
 
                modified_paths = self._apply_insertions(mover)
1745
 
            except:
1746
 
                mover.rollback()
1747
 
                raise
1748
 
            else:
1749
 
                mover.apply_deletions()
1750
 
        finally:
1751
 
            child_pb.finished()
1752
 
        if self.final_file_id(self.root) is None:
1753
 
            inventory_delta = [e for e in inventory_delta if e[0] != '']
1754
 
        self._tree.apply_inventory_delta(inventory_delta)
1755
 
        self._apply_observed_sha1s()
1756
 
        self._done = True
1757
 
        self.finalize()
1758
 
        return _TransformResults(modified_paths, self.rename_count)
1759
 
 
1760
 
    def _generate_inventory_delta(self):
1761
 
        """Generate an inventory delta for the current transform."""
1762
 
        inventory_delta = []
1763
 
        child_pb = ui.ui_factory.nested_progress_bar()
1764
 
        new_paths = self._inventory_altered()
1765
 
        total_entries = len(new_paths) + len(self._removed_id)
1766
 
        try:
1767
 
            for num, trans_id in enumerate(self._removed_id):
1768
 
                if (num % 10) == 0:
1769
 
                    child_pb.update(gettext('removing file'), num, total_entries)
1770
 
                if trans_id == self._new_root:
1771
 
                    file_id = self._tree.get_root_id()
1772
 
                else:
1773
 
                    file_id = self.tree_file_id(trans_id)
1774
 
                # File-id isn't really being deleted, just moved
1775
 
                if file_id in self._r_new_id:
1776
 
                    continue
1777
 
                path = self._tree_id_paths[trans_id]
1778
 
                inventory_delta.append((path, None, file_id, None))
1779
 
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1780
 
                                     new_paths)
1781
 
            entries = self._tree.iter_entries_by_dir(
1782
 
                new_path_file_ids.values())
1783
 
            old_paths = dict((e.file_id, p) for p, e in entries)
1784
 
            final_kinds = {}
1785
 
            for num, (path, trans_id) in enumerate(new_paths):
1786
 
                if (num % 10) == 0:
1787
 
                    child_pb.update(gettext('adding file'),
1788
 
                                    num + len(self._removed_id), total_entries)
1789
 
                file_id = new_path_file_ids[trans_id]
1790
 
                if file_id is None:
1791
 
                    continue
1792
 
                needs_entry = False
1793
 
                kind = self.final_kind(trans_id)
1794
 
                if kind is None:
1795
 
                    kind = self._tree.stored_kind(file_id)
1796
 
                parent_trans_id = self.final_parent(trans_id)
1797
 
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1798
 
                if parent_file_id is None:
1799
 
                    parent_file_id = self.final_file_id(parent_trans_id)
1800
 
                if trans_id in self._new_reference_revision:
1801
 
                    new_entry = inventory.TreeReference(
1802
 
                        file_id,
1803
 
                        self._new_name[trans_id],
1804
 
                        self.final_file_id(self._new_parent[trans_id]),
1805
 
                        None, self._new_reference_revision[trans_id])
1806
 
                else:
1807
 
                    new_entry = inventory.make_entry(kind,
1808
 
                        self.final_name(trans_id),
1809
 
                        parent_file_id, file_id)
1810
 
                old_path = old_paths.get(new_entry.file_id)
1811
 
                new_executability = self._new_executability.get(trans_id)
1812
 
                if new_executability is not None:
1813
 
                    new_entry.executable = new_executability
1814
 
                inventory_delta.append(
1815
 
                    (old_path, path, new_entry.file_id, new_entry))
1816
 
        finally:
1817
 
            child_pb.finished()
1818
 
        return inventory_delta
1819
 
 
1820
 
    def _apply_removals(self, mover):
1821
 
        """Perform tree operations that remove directory/inventory names.
1822
 
 
1823
 
        That is, delete files that are to be deleted, and put any files that
1824
 
        need renaming into limbo.  This must be done in strict child-to-parent
1825
 
        order.
1826
 
 
1827
 
        If inventory_delta is None, no inventory delta generation is performed.
1828
 
        """
1829
 
        tree_paths = list(self._tree_path_ids.iteritems())
1830
 
        tree_paths.sort(reverse=True)
1831
 
        child_pb = ui.ui_factory.nested_progress_bar()
1832
 
        try:
1833
 
            for num, (path, trans_id) in enumerate(tree_paths):
1834
 
                # do not attempt to move root into a subdirectory of itself.
1835
 
                if path == '':
1836
 
                    continue
1837
 
                child_pb.update(gettext('removing file'), num, len(tree_paths))
1838
 
                full_path = self._tree.abspath(path)
1839
 
                if trans_id in self._removed_contents:
1840
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1841
 
                    mover.pre_delete(full_path, delete_path)
1842
 
                elif (trans_id in self._new_name
1843
 
                      or trans_id in self._new_parent):
1844
 
                    try:
1845
 
                        mover.rename(full_path, self._limbo_name(trans_id))
1846
 
                    except errors.TransformRenameFailed, e:
1847
 
                        if e.errno != errno.ENOENT:
1848
 
                            raise
1849
 
                    else:
1850
 
                        self.rename_count += 1
1851
 
        finally:
1852
 
            child_pb.finished()
1853
 
 
1854
 
    def _apply_insertions(self, mover):
1855
 
        """Perform tree operations that insert directory/inventory names.
1856
 
 
1857
 
        That is, create any files that need to be created, and restore from
1858
 
        limbo any files that needed renaming.  This must be done in strict
1859
 
        parent-to-child order.
1860
 
 
1861
 
        If inventory_delta is None, no inventory delta is calculated, and
1862
 
        no list of modified paths is returned.
1863
 
        """
1864
 
        new_paths = self.new_paths(filesystem_only=True)
1865
 
        modified_paths = []
1866
 
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1867
 
                                 new_paths)
1868
 
        child_pb = ui.ui_factory.nested_progress_bar()
1869
 
        try:
1870
 
            for num, (path, trans_id) in enumerate(new_paths):
1871
 
                if (num % 10) == 0:
1872
 
                    child_pb.update(gettext('adding file'), num, len(new_paths))
1873
 
                full_path = self._tree.abspath(path)
1874
 
                if trans_id in self._needs_rename:
1875
 
                    try:
1876
 
                        mover.rename(self._limbo_name(trans_id), full_path)
1877
 
                    except errors.TransformRenameFailed, e:
1878
 
                        # We may be renaming a dangling inventory id
1879
 
                        if e.errno != errno.ENOENT:
1880
 
                            raise
1881
 
                    else:
1882
 
                        self.rename_count += 1
1883
 
                    # TODO: if trans_id in self._observed_sha1s, we should
1884
 
                    #       re-stat the final target, since ctime will be
1885
 
                    #       updated by the change.
1886
 
                if (trans_id in self._new_contents or
1887
 
                    self.path_changed(trans_id)):
1888
 
                    if trans_id in self._new_contents:
1889
 
                        modified_paths.append(full_path)
1890
 
                if trans_id in self._new_executability:
1891
 
                    self._set_executability(path, trans_id)
1892
 
                if trans_id in self._observed_sha1s:
1893
 
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
1894
 
                    st = osutils.lstat(full_path)
1895
 
                    self._observed_sha1s[trans_id] = (o_sha1, st)
1896
 
        finally:
1897
 
            child_pb.finished()
1898
 
        for path, trans_id in new_paths:
1899
 
            # new_paths includes stuff like workingtree conflicts. Only the
1900
 
            # stuff in new_contents actually comes from limbo.
1901
 
            if trans_id in self._limbo_files:
1902
 
                del self._limbo_files[trans_id]
1903
 
        self._new_contents.clear()
1904
 
        return modified_paths
1905
 
 
1906
 
    def _apply_observed_sha1s(self):
1907
 
        """After we have finished renaming everything, update observed sha1s
1908
 
 
1909
 
        This has to be done after self._tree.apply_inventory_delta, otherwise
1910
 
        it doesn't know anything about the files we are updating. Also, we want
1911
 
        to do this as late as possible, so that most entries end up cached.
1912
 
        """
1913
 
        # TODO: this doesn't update the stat information for directories. So
1914
 
        #       the first 'bzr status' will still need to rewrite
1915
 
        #       .bzr/checkout/dirstate. However, we at least don't need to
1916
 
        #       re-read all of the files.
1917
 
        # TODO: If the operation took a while, we could do a time.sleep(3) here
1918
 
        #       to allow the clock to tick over and ensure we won't have any
1919
 
        #       problems. (we could observe start time, and finish time, and if
1920
 
        #       it is less than eg 10% overhead, add a sleep call.)
1921
 
        paths = FinalPaths(self)
1922
 
        for trans_id, observed in self._observed_sha1s.iteritems():
1923
 
            path = paths.get_path(trans_id)
1924
 
            # We could get the file_id, but dirstate prefers to use the path
1925
 
            # anyway, and it is 'cheaper' to determine.
1926
 
            # file_id = self._new_id[trans_id]
1927
 
            self._tree._observed_sha1(None, path, observed)
1928
 
 
1929
 
 
1930
 
class TransformPreview(DiskTreeTransform):
1931
 
    """A TreeTransform for generating preview trees.
1932
 
 
1933
 
    Unlike TreeTransform, this version works when the input tree is a
1934
 
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
1935
 
    unversioned files in the input tree.
1936
 
    """
1937
 
 
1938
 
    def __init__(self, tree, pb=None, case_sensitive=True):
1939
 
        tree.lock_read()
1940
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1941
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1942
 
 
1943
 
    def canonical_path(self, path):
1944
 
        return path
1945
 
 
1946
 
    def tree_kind(self, trans_id):
1947
 
        path = self._tree_id_paths.get(trans_id)
1948
 
        if path is None:
1949
 
            return None
1950
 
        kind = self._tree.path_content_summary(path)[0]
1951
 
        if kind == 'missing':
1952
 
            kind = None
1953
 
        return kind
1954
 
 
1955
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1956
 
        """Set the mode of new file contents.
1957
 
        The mode_id is the existing file to get the mode from (often the same
1958
 
        as trans_id).  The operation is only performed if there's a mode match
1959
 
        according to typefunc.
1960
 
        """
1961
 
        # is it ok to ignore this?  probably
1962
 
        pass
1963
 
 
1964
 
    def iter_tree_children(self, parent_id):
1965
 
        """Iterate through the entry's tree children, if any"""
1966
 
        try:
1967
 
            path = self._tree_id_paths[parent_id]
1968
 
        except KeyError:
1969
 
            return
1970
 
        file_id = self.tree_file_id(parent_id)
1971
 
        if file_id is None:
1972
 
            return
1973
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1974
 
        children = getattr(entry, 'children', {})
1975
 
        for child in children:
1976
 
            childpath = joinpath(path, child)
1977
 
            yield self.trans_id_tree_path(childpath)
1978
 
 
1979
 
    def new_orphan(self, trans_id, parent_id):
1980
 
        raise NotImplementedError(self.new_orphan)
1981
 
 
1982
 
 
1983
 
class _PreviewTree(tree.InventoryTree):
1984
 
    """Partial implementation of Tree to support show_diff_trees"""
1985
 
 
1986
 
    def __init__(self, transform):
1987
 
        self._transform = transform
1988
 
        self._final_paths = FinalPaths(transform)
1989
 
        self.__by_parent = None
1990
 
        self._parent_ids = []
1991
 
        self._all_children_cache = {}
1992
 
        self._path2trans_id_cache = {}
1993
 
        self._final_name_cache = {}
1994
 
        self._iter_changes_cache = dict((c[0], c) for c in
1995
 
                                        self._transform.iter_changes())
1996
 
 
1997
 
    def _content_change(self, file_id):
1998
 
        """Return True if the content of this file changed"""
1999
 
        changes = self._iter_changes_cache.get(file_id)
2000
 
        # changes[2] is true if the file content changed.  See
2001
 
        # InterTree.iter_changes.
2002
 
        return (changes is not None and changes[2])
2003
 
 
2004
 
    def _get_repository(self):
2005
 
        repo = getattr(self._transform._tree, '_repository', None)
2006
 
        if repo is None:
2007
 
            repo = self._transform._tree.branch.repository
2008
 
        return repo
2009
 
 
2010
 
    def _iter_parent_trees(self):
2011
 
        for revision_id in self.get_parent_ids():
2012
 
            try:
2013
 
                yield self.revision_tree(revision_id)
2014
 
            except errors.NoSuchRevisionInTree:
2015
 
                yield self._get_repository().revision_tree(revision_id)
2016
 
 
2017
 
    def _get_file_revision(self, file_id, vf, tree_revision):
2018
 
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2019
 
                       self._iter_parent_trees()]
2020
 
        vf.add_lines((file_id, tree_revision), parent_keys,
2021
 
                     self.get_file_lines(file_id))
2022
 
        repo = self._get_repository()
2023
 
        base_vf = repo.texts
2024
 
        if base_vf not in vf.fallback_versionedfiles:
2025
 
            vf.fallback_versionedfiles.append(base_vf)
2026
 
        return tree_revision
2027
 
 
2028
 
    def _stat_limbo_file(self, file_id=None, trans_id=None):
2029
 
        if trans_id is None:
2030
 
            trans_id = self._transform.trans_id_file_id(file_id)
2031
 
        name = self._transform._limbo_name(trans_id)
2032
 
        return os.lstat(name)
2033
 
 
2034
 
    @property
2035
 
    def _by_parent(self):
2036
 
        if self.__by_parent is None:
2037
 
            self.__by_parent = self._transform.by_parent()
2038
 
        return self.__by_parent
2039
 
 
2040
 
    def _comparison_data(self, entry, path):
2041
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2042
 
        if kind == 'missing':
2043
 
            kind = None
2044
 
            executable = False
2045
 
        else:
2046
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
2047
 
            executable = self.is_executable(file_id, path)
2048
 
        return kind, executable, None
2049
 
 
2050
 
    def is_locked(self):
2051
 
        return False
2052
 
 
2053
 
    def lock_read(self):
2054
 
        # Perhaps in theory, this should lock the TreeTransform?
2055
 
        return self
2056
 
 
2057
 
    def unlock(self):
2058
 
        pass
2059
 
 
2060
 
    @property
2061
 
    def inventory(self):
2062
 
        """This Tree does not use inventory as its backing data."""
2063
 
        raise NotImplementedError(_PreviewTree.inventory)
2064
 
 
2065
 
    def get_root_id(self):
2066
 
        return self._transform.final_file_id(self._transform.root)
2067
 
 
2068
 
    def all_file_ids(self):
2069
 
        tree_ids = set(self._transform._tree.all_file_ids())
2070
 
        tree_ids.difference_update(self._transform.tree_file_id(t)
2071
 
                                   for t in self._transform._removed_id)
2072
 
        tree_ids.update(self._transform._new_id.values())
2073
 
        return tree_ids
2074
 
 
2075
 
    def __iter__(self):
2076
 
        return iter(self.all_file_ids())
2077
 
 
2078
 
    def _has_id(self, file_id, fallback_check):
2079
 
        if file_id in self._transform._r_new_id:
2080
 
            return True
2081
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
2082
 
            trans_id in self._transform._removed_id]):
2083
 
            return False
2084
 
        else:
2085
 
            return fallback_check(file_id)
2086
 
 
2087
 
    def has_id(self, file_id):
2088
 
        return self._has_id(file_id, self._transform._tree.has_id)
2089
 
 
2090
 
    def has_or_had_id(self, file_id):
2091
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
2092
 
 
2093
 
    def _path2trans_id(self, path):
2094
 
        # We must not use None here, because that is a valid value to store.
2095
 
        trans_id = self._path2trans_id_cache.get(path, object)
2096
 
        if trans_id is not object:
2097
 
            return trans_id
2098
 
        segments = splitpath(path)
2099
 
        cur_parent = self._transform.root
2100
 
        for cur_segment in segments:
2101
 
            for child in self._all_children(cur_parent):
2102
 
                final_name = self._final_name_cache.get(child)
2103
 
                if final_name is None:
2104
 
                    final_name = self._transform.final_name(child)
2105
 
                    self._final_name_cache[child] = final_name
2106
 
                if final_name == cur_segment:
2107
 
                    cur_parent = child
2108
 
                    break
2109
 
            else:
2110
 
                self._path2trans_id_cache[path] = None
2111
 
                return None
2112
 
        self._path2trans_id_cache[path] = cur_parent
2113
 
        return cur_parent
2114
 
 
2115
 
    def path2id(self, path):
2116
 
        return self._transform.final_file_id(self._path2trans_id(path))
2117
 
 
2118
 
    def id2path(self, file_id):
2119
 
        trans_id = self._transform.trans_id_file_id(file_id)
2120
 
        try:
2121
 
            return self._final_paths._determine_path(trans_id)
2122
 
        except NoFinalPath:
2123
 
            raise errors.NoSuchId(self, file_id)
2124
 
 
2125
 
    def _all_children(self, trans_id):
2126
 
        children = self._all_children_cache.get(trans_id)
2127
 
        if children is not None:
2128
 
            return children
2129
 
        children = set(self._transform.iter_tree_children(trans_id))
2130
 
        # children in the _new_parent set are provided by _by_parent.
2131
 
        children.difference_update(self._transform._new_parent.keys())
2132
 
        children.update(self._by_parent.get(trans_id, []))
2133
 
        self._all_children_cache[trans_id] = children
2134
 
        return children
2135
 
 
2136
 
    def iter_children(self, file_id):
2137
 
        trans_id = self._transform.trans_id_file_id(file_id)
2138
 
        for child_trans_id in self._all_children(trans_id):
2139
 
            yield self._transform.final_file_id(child_trans_id)
2140
 
 
2141
 
    def extras(self):
2142
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
2143
 
                              in self._transform._tree.extras())
2144
 
        possible_extras.update(self._transform._new_contents)
2145
 
        possible_extras.update(self._transform._removed_id)
2146
 
        for trans_id in possible_extras:
2147
 
            if self._transform.final_file_id(trans_id) is None:
2148
 
                yield self._final_paths._determine_path(trans_id)
2149
 
 
2150
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2151
 
        yield_parents=False):
2152
 
        for trans_id, parent_file_id in ordered_entries:
2153
 
            file_id = self._transform.final_file_id(trans_id)
2154
 
            if file_id is None:
2155
 
                continue
2156
 
            if (specific_file_ids is not None
2157
 
                and file_id not in specific_file_ids):
2158
 
                continue
2159
 
            kind = self._transform.final_kind(trans_id)
2160
 
            if kind is None:
2161
 
                kind = self._transform._tree.stored_kind(file_id)
2162
 
            new_entry = inventory.make_entry(
2163
 
                kind,
2164
 
                self._transform.final_name(trans_id),
2165
 
                parent_file_id, file_id)
2166
 
            yield new_entry, trans_id
2167
 
 
2168
 
    def _list_files_by_dir(self):
2169
 
        todo = [ROOT_PARENT]
2170
 
        ordered_ids = []
2171
 
        while len(todo) > 0:
2172
 
            parent = todo.pop()
2173
 
            parent_file_id = self._transform.final_file_id(parent)
2174
 
            children = list(self._all_children(parent))
2175
 
            paths = dict(zip(children, self._final_paths.get_paths(children)))
2176
 
            children.sort(key=paths.get)
2177
 
            todo.extend(reversed(children))
2178
 
            for trans_id in children:
2179
 
                ordered_ids.append((trans_id, parent_file_id))
2180
 
        return ordered_ids
2181
 
 
2182
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2183
 
        # This may not be a maximally efficient implementation, but it is
2184
 
        # reasonably straightforward.  An implementation that grafts the
2185
 
        # TreeTransform changes onto the tree's iter_entries_by_dir results
2186
 
        # might be more efficient, but requires tricky inferences about stack
2187
 
        # position.
2188
 
        ordered_ids = self._list_files_by_dir()
2189
 
        for entry, trans_id in self._make_inv_entries(ordered_ids,
2190
 
            specific_file_ids, yield_parents=yield_parents):
2191
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
2192
 
 
2193
 
    def _iter_entries_for_dir(self, dir_path):
2194
 
        """Return path, entry for items in a directory without recursing down."""
2195
 
        dir_file_id = self.path2id(dir_path)
2196
 
        ordered_ids = []
2197
 
        for file_id in self.iter_children(dir_file_id):
2198
 
            trans_id = self._transform.trans_id_file_id(file_id)
2199
 
            ordered_ids.append((trans_id, file_id))
2200
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
2201
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
2202
 
 
2203
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
2204
 
        """See WorkingTree.list_files."""
2205
 
        # XXX This should behave like WorkingTree.list_files, but is really
2206
 
        # more like RevisionTree.list_files.
2207
 
        if recursive:
2208
 
            prefix = None
2209
 
            if from_dir:
2210
 
                prefix = from_dir + '/'
2211
 
            entries = self.iter_entries_by_dir()
2212
 
            for path, entry in entries:
2213
 
                if entry.name == '' and not include_root:
2214
 
                    continue
2215
 
                if prefix:
2216
 
                    if not path.startswith(prefix):
2217
 
                        continue
2218
 
                    path = path[len(prefix):]
2219
 
                yield path, 'V', entry.kind, entry.file_id, entry
2220
 
        else:
2221
 
            if from_dir is None and include_root is True:
2222
 
                root_entry = inventory.make_entry('directory', '',
2223
 
                    ROOT_PARENT, self.get_root_id())
2224
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
2225
 
            entries = self._iter_entries_for_dir(from_dir or '')
2226
 
            for path, entry in entries:
2227
 
                yield path, 'V', entry.kind, entry.file_id, entry
2228
 
 
2229
 
    def kind(self, file_id):
2230
 
        trans_id = self._transform.trans_id_file_id(file_id)
2231
 
        return self._transform.final_kind(trans_id)
2232
 
 
2233
 
    def stored_kind(self, file_id):
2234
 
        trans_id = self._transform.trans_id_file_id(file_id)
2235
 
        try:
2236
 
            return self._transform._new_contents[trans_id]
2237
 
        except KeyError:
2238
 
            return self._transform._tree.stored_kind(file_id)
2239
 
 
2240
 
    def get_file_mtime(self, file_id, path=None):
2241
 
        """See Tree.get_file_mtime"""
2242
 
        if not self._content_change(file_id):
2243
 
            return self._transform._tree.get_file_mtime(file_id)
2244
 
        return self._stat_limbo_file(file_id).st_mtime
2245
 
 
2246
 
    def _file_size(self, entry, stat_value):
2247
 
        return self.get_file_size(entry.file_id)
2248
 
 
2249
 
    def get_file_size(self, file_id):
2250
 
        """See Tree.get_file_size"""
2251
 
        trans_id = self._transform.trans_id_file_id(file_id)
2252
 
        kind = self._transform.final_kind(trans_id)
2253
 
        if kind != 'file':
2254
 
            return None
2255
 
        if trans_id in self._transform._new_contents:
2256
 
            return self._stat_limbo_file(trans_id=trans_id).st_size
2257
 
        if self.kind(file_id) == 'file':
2258
 
            return self._transform._tree.get_file_size(file_id)
2259
 
        else:
2260
 
            return None
2261
 
 
2262
 
    def get_file_verifier(self, file_id, path=None, stat_value=None):
2263
 
        trans_id = self._transform.trans_id_file_id(file_id)
2264
 
        kind = self._transform._new_contents.get(trans_id)
2265
 
        if kind is None:
2266
 
            return self._transform._tree.get_file_verifier(file_id)
2267
 
        if kind == 'file':
2268
 
            fileobj = self.get_file(file_id)
2269
 
            try:
2270
 
                return ("SHA1", sha_file(fileobj))
2271
 
            finally:
2272
 
                fileobj.close()
2273
 
 
2274
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2275
 
        trans_id = self._transform.trans_id_file_id(file_id)
2276
 
        kind = self._transform._new_contents.get(trans_id)
2277
 
        if kind is None:
2278
 
            return self._transform._tree.get_file_sha1(file_id)
2279
 
        if kind == 'file':
2280
 
            fileobj = self.get_file(file_id)
2281
 
            try:
2282
 
                return sha_file(fileobj)
2283
 
            finally:
2284
 
                fileobj.close()
2285
 
 
2286
 
    def is_executable(self, file_id, path=None):
2287
 
        if file_id is None:
2288
 
            return False
2289
 
        trans_id = self._transform.trans_id_file_id(file_id)
2290
 
        try:
2291
 
            return self._transform._new_executability[trans_id]
2292
 
        except KeyError:
2293
 
            try:
2294
 
                return self._transform._tree.is_executable(file_id, path)
2295
 
            except OSError, e:
2296
 
                if e.errno == errno.ENOENT:
2297
 
                    return False
2298
 
                raise
2299
 
            except errors.NoSuchId:
2300
 
                return False
2301
 
 
2302
 
    def has_filename(self, path):
2303
 
        trans_id = self._path2trans_id(path)
2304
 
        if trans_id in self._transform._new_contents:
2305
 
            return True
2306
 
        elif trans_id in self._transform._removed_contents:
2307
 
            return False
2308
 
        else:
2309
 
            return self._transform._tree.has_filename(path)
2310
 
 
2311
 
    def path_content_summary(self, path):
2312
 
        trans_id = self._path2trans_id(path)
2313
 
        tt = self._transform
2314
 
        tree_path = tt._tree_id_paths.get(trans_id)
2315
 
        kind = tt._new_contents.get(trans_id)
2316
 
        if kind is None:
2317
 
            if tree_path is None or trans_id in tt._removed_contents:
2318
 
                return 'missing', None, None, None
2319
 
            summary = tt._tree.path_content_summary(tree_path)
2320
 
            kind, size, executable, link_or_sha1 = summary
2321
 
        else:
2322
 
            link_or_sha1 = None
2323
 
            limbo_name = tt._limbo_name(trans_id)
2324
 
            if trans_id in tt._new_reference_revision:
2325
 
                kind = 'tree-reference'
2326
 
            if kind == 'file':
2327
 
                statval = os.lstat(limbo_name)
2328
 
                size = statval.st_size
2329
 
                if not supports_executable():
2330
 
                    executable = False
2331
 
                else:
2332
 
                    executable = statval.st_mode & S_IEXEC
2333
 
            else:
2334
 
                size = None
2335
 
                executable = None
2336
 
            if kind == 'symlink':
2337
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2338
 
        executable = tt._new_executability.get(trans_id, executable)
2339
 
        return kind, size, executable, link_or_sha1
2340
 
 
2341
 
    def iter_changes(self, from_tree, include_unchanged=False,
2342
 
                      specific_files=None, pb=None, extra_trees=None,
2343
 
                      require_versioned=True, want_unversioned=False):
2344
 
        """See InterTree.iter_changes.
2345
 
 
2346
 
        This has a fast path that is only used when the from_tree matches
2347
 
        the transform tree, and no fancy options are supplied.
2348
 
        """
2349
 
        if (from_tree is not self._transform._tree or include_unchanged or
2350
 
            specific_files or want_unversioned):
2351
 
            return tree.InterTree(from_tree, self).iter_changes(
2352
 
                include_unchanged=include_unchanged,
2353
 
                specific_files=specific_files,
2354
 
                pb=pb,
2355
 
                extra_trees=extra_trees,
2356
 
                require_versioned=require_versioned,
2357
 
                want_unversioned=want_unversioned)
2358
 
        if want_unversioned:
2359
 
            raise ValueError('want_unversioned is not supported')
2360
 
        return self._transform.iter_changes()
2361
 
 
2362
 
    def get_file(self, file_id, path=None):
2363
 
        """See Tree.get_file"""
2364
 
        if not self._content_change(file_id):
2365
 
            return self._transform._tree.get_file(file_id, path)
2366
 
        trans_id = self._transform.trans_id_file_id(file_id)
2367
 
        name = self._transform._limbo_name(trans_id)
2368
 
        return open(name, 'rb')
2369
 
 
2370
 
    def get_file_with_stat(self, file_id, path=None):
2371
 
        return self.get_file(file_id, path), None
2372
 
 
2373
 
    def annotate_iter(self, file_id,
2374
 
                      default_revision=_mod_revision.CURRENT_REVISION):
2375
 
        changes = self._iter_changes_cache.get(file_id)
2376
 
        if changes is None:
2377
 
            get_old = True
2378
 
        else:
2379
 
            changed_content, versioned, kind = (changes[2], changes[3],
2380
 
                                                changes[6])
2381
 
            if kind[1] is None:
2382
 
                return None
2383
 
            get_old = (kind[0] == 'file' and versioned[0])
2384
 
        if get_old:
2385
 
            old_annotation = self._transform._tree.annotate_iter(file_id,
2386
 
                default_revision=default_revision)
2387
 
        else:
2388
 
            old_annotation = []
2389
 
        if changes is None:
2390
 
            return old_annotation
2391
 
        if not changed_content:
2392
 
            return old_annotation
2393
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2394
 
        #       doing, however it fails slightly because it doesn't know what
2395
 
        #       the *other* revision_id is, so it doesn't know how to give the
2396
 
        #       other as the origin for some lines, they all get
2397
 
        #       'default_revision'
2398
 
        #       It would be nice to be able to use the new Annotator based
2399
 
        #       approach, as well.
2400
 
        return annotate.reannotate([old_annotation],
2401
 
                                   self.get_file(file_id).readlines(),
2402
 
                                   default_revision)
2403
 
 
2404
 
    def get_symlink_target(self, file_id, path=None):
2405
 
        """See Tree.get_symlink_target"""
2406
 
        if not self._content_change(file_id):
2407
 
            return self._transform._tree.get_symlink_target(file_id)
2408
 
        trans_id = self._transform.trans_id_file_id(file_id)
2409
 
        name = self._transform._limbo_name(trans_id)
2410
 
        return osutils.readlink(name)
2411
 
 
2412
 
    def walkdirs(self, prefix=''):
2413
 
        pending = [self._transform.root]
2414
 
        while len(pending) > 0:
2415
 
            parent_id = pending.pop()
2416
 
            children = []
2417
 
            subdirs = []
2418
 
            prefix = prefix.rstrip('/')
2419
 
            parent_path = self._final_paths.get_path(parent_id)
2420
 
            parent_file_id = self._transform.final_file_id(parent_id)
2421
 
            for child_id in self._all_children(parent_id):
2422
 
                path_from_root = self._final_paths.get_path(child_id)
2423
 
                basename = self._transform.final_name(child_id)
2424
 
                file_id = self._transform.final_file_id(child_id)
2425
 
                kind  = self._transform.final_kind(child_id)
2426
 
                if kind is not None:
2427
 
                    versioned_kind = kind
2428
 
                else:
2429
 
                    kind = 'unknown'
2430
 
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2431
 
                if versioned_kind == 'directory':
2432
 
                    subdirs.append(child_id)
2433
 
                children.append((path_from_root, basename, kind, None,
2434
 
                                 file_id, versioned_kind))
2435
 
            children.sort()
2436
 
            if parent_path.startswith(prefix):
2437
 
                yield (parent_path, parent_file_id), children
2438
 
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2439
 
                                  reverse=True))
2440
 
 
2441
 
    def get_parent_ids(self):
2442
 
        return self._parent_ids
2443
 
 
2444
 
    def set_parent_ids(self, parent_ids):
2445
 
        self._parent_ids = parent_ids
2446
 
 
2447
 
    def get_revision_tree(self, revision_id):
2448
 
        return self._transform._tree.get_revision_tree(revision_id)
2449
 
 
2450
 
 
2451
816
def joinpath(parent, child):
2452
817
    """Join tree-relative paths, handling the tree root specially"""
2453
818
    if parent is None or parent == "":
2468
833
        self.transform = transform
2469
834
 
2470
835
    def _determine_path(self, trans_id):
2471
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
836
        if trans_id == self.transform.root:
2472
837
            return ""
2473
838
        name = self.transform.final_name(trans_id)
2474
839
        parent_id = self.transform.final_parent(trans_id)
2483
848
            self._known_paths[trans_id] = self._determine_path(trans_id)
2484
849
        return self._known_paths[trans_id]
2485
850
 
2486
 
    def get_paths(self, trans_ids):
2487
 
        return [(self.get_path(t), t) for t in trans_ids]
2488
 
 
2489
 
 
2490
 
 
2491
851
def topology_sorted_ids(tree):
2492
852
    """Determine the topological order of the ids in a tree"""
2493
853
    file_ids = list(tree)
2494
854
    file_ids.sort(key=tree.id2path)
2495
855
    return file_ids
2496
856
 
2497
 
 
2498
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2499
 
               delta_from_tree=False):
2500
 
    """Create working tree for a branch, using a TreeTransform.
2501
 
 
2502
 
    This function should be used on empty trees, having a tree root at most.
2503
 
    (see merge and revert functionality for working with existing trees)
2504
 
 
2505
 
    Existing files are handled like so:
2506
 
 
2507
 
    - Existing bzrdirs take precedence over creating new items.  They are
2508
 
      created as '%s.diverted' % name.
2509
 
    - Otherwise, if the content on disk matches the content we are building,
2510
 
      it is silently replaced.
2511
 
    - Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2512
 
 
2513
 
    :param tree: The tree to convert wt into a copy of
2514
 
    :param wt: The working tree that files will be placed into
2515
 
    :param accelerator_tree: A tree which can be used for retrieving file
2516
 
        contents more quickly than tree itself, i.e. a workingtree.  tree
2517
 
        will be used for cases where accelerator_tree's content is different.
2518
 
    :param hardlink: If true, hard-link files to accelerator_tree, where
2519
 
        possible.  accelerator_tree must implement abspath, i.e. be a
2520
 
        working tree.
2521
 
    :param delta_from_tree: If true, build_tree may use the input Tree to
2522
 
        generate the inventory delta.
2523
 
    """
2524
 
    wt.lock_tree_write()
2525
 
    try:
2526
 
        tree.lock_read()
2527
 
        try:
2528
 
            if accelerator_tree is not None:
2529
 
                accelerator_tree.lock_read()
2530
 
            try:
2531
 
                return _build_tree(tree, wt, accelerator_tree, hardlink,
2532
 
                                   delta_from_tree)
2533
 
            finally:
2534
 
                if accelerator_tree is not None:
2535
 
                    accelerator_tree.unlock()
2536
 
        finally:
2537
 
            tree.unlock()
2538
 
    finally:
2539
 
        wt.unlock()
2540
 
 
2541
 
 
2542
 
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2543
 
    """See build_tree."""
2544
 
    for num, _unused in enumerate(wt.all_file_ids()):
2545
 
        if num > 0:  # more than just a root
2546
 
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
857
def build_tree(tree, wt):
 
858
    """Create working tree for a branch, using a Transaction."""
2547
859
    file_trans_id = {}
2548
 
    top_pb = ui.ui_factory.nested_progress_bar()
2549
 
    pp = ProgressPhase("Build phase", 2, top_pb)
2550
 
    if tree.inventory.root is not None:
2551
 
        # This is kind of a hack: we should be altering the root
2552
 
        # as part of the regular tree shape diff logic.
2553
 
        # The conditional test here is to avoid doing an
2554
 
        # expensive operation (flush) every time the root id
2555
 
        # is set within the tree, nor setting the root and thus
2556
 
        # marking the tree as dirty, because we use two different
2557
 
        # idioms here: tree interfaces and inventory interfaces.
2558
 
        if wt.get_root_id() != tree.get_root_id():
2559
 
            wt.set_root_id(tree.get_root_id())
2560
 
            wt.flush()
2561
860
    tt = TreeTransform(wt)
2562
 
    divert = set()
2563
861
    try:
2564
 
        pp.next_phase()
2565
 
        file_trans_id[wt.get_root_id()] = \
2566
 
            tt.trans_id_tree_file_id(wt.get_root_id())
2567
 
        pb = ui.ui_factory.nested_progress_bar()
2568
 
        try:
2569
 
            deferred_contents = []
2570
 
            num = 0
2571
 
            total = len(tree.inventory)
2572
 
            if delta_from_tree:
2573
 
                precomputed_delta = []
2574
 
            else:
2575
 
                precomputed_delta = None
2576
 
            # Check if tree inventory has content. If so, we populate
2577
 
            # existing_files with the directory content. If there are no
2578
 
            # entries we skip populating existing_files as its not used.
2579
 
            # This improves performance and unncessary work on large
2580
 
            # directory trees. (#501307)
2581
 
            if total > 0:
2582
 
                existing_files = set()
2583
 
                for dir, files in wt.walkdirs():
2584
 
                    existing_files.update(f[0] for f in files)
2585
 
            for num, (tree_path, entry) in \
2586
 
                enumerate(tree.inventory.iter_entries_by_dir()):
2587
 
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2588
 
                if entry.parent_id is None:
2589
 
                    continue
2590
 
                reparent = False
2591
 
                file_id = entry.file_id
2592
 
                if delta_from_tree:
2593
 
                    precomputed_delta.append((None, tree_path, file_id, entry))
2594
 
                if tree_path in existing_files:
2595
 
                    target_path = wt.abspath(tree_path)
2596
 
                    kind = file_kind(target_path)
2597
 
                    if kind == "directory":
2598
 
                        try:
2599
 
                            bzrdir.BzrDir.open(target_path)
2600
 
                        except errors.NotBranchError:
2601
 
                            pass
2602
 
                        else:
2603
 
                            divert.add(file_id)
2604
 
                    if (file_id not in divert and
2605
 
                        _content_match(tree, entry, file_id, kind,
2606
 
                        target_path)):
2607
 
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2608
 
                        if kind == 'directory':
2609
 
                            reparent = True
2610
 
                parent_id = file_trans_id[entry.parent_id]
2611
 
                if entry.kind == 'file':
2612
 
                    # We *almost* replicate new_by_entry, so that we can defer
2613
 
                    # getting the file text, and get them all at once.
2614
 
                    trans_id = tt.create_path(entry.name, parent_id)
2615
 
                    file_trans_id[file_id] = trans_id
2616
 
                    tt.version_file(file_id, trans_id)
2617
 
                    executable = tree.is_executable(file_id, tree_path)
2618
 
                    if executable:
2619
 
                        tt.set_executability(executable, trans_id)
2620
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
2621
 
                    deferred_contents.append((file_id, trans_data))
2622
 
                else:
2623
 
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2624
 
                                                          tree)
2625
 
                if reparent:
2626
 
                    new_trans_id = file_trans_id[file_id]
2627
 
                    old_parent = tt.trans_id_tree_path(tree_path)
2628
 
                    _reparent_children(tt, old_parent, new_trans_id)
2629
 
            offset = num + 1 - len(deferred_contents)
2630
 
            _create_files(tt, tree, deferred_contents, pb, offset,
2631
 
                          accelerator_tree, hardlink)
2632
 
        finally:
2633
 
            pb.finished()
2634
 
        pp.next_phase()
2635
 
        divert_trans = set(file_trans_id[f] for f in divert)
2636
 
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2637
 
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2638
 
        if len(raw_conflicts) > 0:
2639
 
            precomputed_delta = None
2640
 
        conflicts = cook_conflicts(raw_conflicts, tt)
2641
 
        for conflict in conflicts:
2642
 
            trace.warning(unicode(conflict))
2643
 
        try:
2644
 
            wt.add_conflicts(conflicts)
2645
 
        except errors.UnsupportedOperation:
2646
 
            pass
2647
 
        result = tt.apply(no_conflicts=True,
2648
 
                          precomputed_delta=precomputed_delta)
 
862
        file_trans_id[wt.get_root_id()] = tt.trans_id_tree_file_id(wt.get_root_id())
 
863
        file_ids = topology_sorted_ids(tree)
 
864
        for file_id in file_ids:
 
865
            entry = tree.inventory[file_id]
 
866
            if entry.parent_id is None:
 
867
                continue
 
868
            if entry.parent_id not in file_trans_id:
 
869
                raise repr(entry.parent_id)
 
870
            parent_id = file_trans_id[entry.parent_id]
 
871
            file_trans_id[file_id] = new_by_entry(tt, entry, parent_id, tree)
 
872
        tt.apply()
2649
873
    finally:
2650
874
        tt.finalize()
2651
 
        top_pb.finished()
2652
 
    return result
2653
 
 
2654
 
 
2655
 
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2656
 
                  hardlink):
2657
 
    total = len(desired_files) + offset
2658
 
    wt = tt._tree
2659
 
    if accelerator_tree is None:
2660
 
        new_desired_files = desired_files
2661
 
    else:
2662
 
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2663
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2664
 
                     in iter if not (c or e[0] != e[1])]
2665
 
        if accelerator_tree.supports_content_filtering():
2666
 
            unchanged = [(f, p) for (f, p) in unchanged
2667
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2668
 
        unchanged = dict(unchanged)
2669
 
        new_desired_files = []
2670
 
        count = 0
2671
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2672
 
            accelerator_path = unchanged.get(file_id)
2673
 
            if accelerator_path is None:
2674
 
                new_desired_files.append((file_id,
2675
 
                    (trans_id, tree_path, text_sha1)))
2676
 
                continue
2677
 
            pb.update(gettext('Adding file contents'), count + offset, total)
2678
 
            if hardlink:
2679
 
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2680
 
                                   trans_id)
2681
 
            else:
2682
 
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2683
 
                if wt.supports_content_filtering():
2684
 
                    filters = wt._content_filter_stack(tree_path)
2685
 
                    contents = filtered_output_bytes(contents, filters,
2686
 
                        ContentFilterContext(tree_path, tree))
2687
 
                try:
2688
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
2689
 
                finally:
2690
 
                    try:
2691
 
                        contents.close()
2692
 
                    except AttributeError:
2693
 
                        # after filtering, contents may no longer be file-like
2694
 
                        pass
2695
 
            count += 1
2696
 
        offset += count
2697
 
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2698
 
            tree.iter_files_bytes(new_desired_files)):
2699
 
        if wt.supports_content_filtering():
2700
 
            filters = wt._content_filter_stack(tree_path)
2701
 
            contents = filtered_output_bytes(contents, filters,
2702
 
                ContentFilterContext(tree_path, tree))
2703
 
        tt.create_file(contents, trans_id, sha1=text_sha1)
2704
 
        pb.update(gettext('Adding file contents'), count + offset, total)
2705
 
 
2706
 
 
2707
 
def _reparent_children(tt, old_parent, new_parent):
2708
 
    for child in tt.iter_tree_children(old_parent):
2709
 
        tt.adjust_path(tt.final_name(child), new_parent, child)
2710
 
 
2711
 
 
2712
 
def _reparent_transform_children(tt, old_parent, new_parent):
2713
 
    by_parent = tt.by_parent()
2714
 
    for child in by_parent[old_parent]:
2715
 
        tt.adjust_path(tt.final_name(child), new_parent, child)
2716
 
    return by_parent[old_parent]
2717
 
 
2718
 
 
2719
 
def _content_match(tree, entry, file_id, kind, target_path):
2720
 
    if entry.kind != kind:
2721
 
        return False
2722
 
    if entry.kind == "directory":
2723
 
        return True
2724
 
    if entry.kind == "file":
2725
 
        f = file(target_path, 'rb')
2726
 
        try:
2727
 
            if tree.get_file_text(file_id) == f.read():
2728
 
                return True
2729
 
        finally:
2730
 
            f.close()
2731
 
    elif entry.kind == "symlink":
2732
 
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2733
 
            return True
2734
 
    return False
2735
 
 
2736
 
 
2737
 
def resolve_checkout(tt, conflicts, divert):
2738
 
    new_conflicts = set()
2739
 
    for c_type, conflict in ((c[0], c) for c in conflicts):
2740
 
        # Anything but a 'duplicate' would indicate programmer error
2741
 
        if c_type != 'duplicate':
2742
 
            raise AssertionError(c_type)
2743
 
        # Now figure out which is new and which is old
2744
 
        if tt.new_contents(conflict[1]):
2745
 
            new_file = conflict[1]
2746
 
            old_file = conflict[2]
2747
 
        else:
2748
 
            new_file = conflict[2]
2749
 
            old_file = conflict[1]
2750
 
 
2751
 
        # We should only get here if the conflict wasn't completely
2752
 
        # resolved
2753
 
        final_parent = tt.final_parent(old_file)
2754
 
        if new_file in divert:
2755
 
            new_name = tt.final_name(old_file)+'.diverted'
2756
 
            tt.adjust_path(new_name, final_parent, new_file)
2757
 
            new_conflicts.add((c_type, 'Diverted to',
2758
 
                               new_file, old_file))
2759
 
        else:
2760
 
            new_name = tt.final_name(old_file)+'.moved'
2761
 
            tt.adjust_path(new_name, final_parent, old_file)
2762
 
            new_conflicts.add((c_type, 'Moved existing file to',
2763
 
                               old_file, new_file))
2764
 
    return new_conflicts
2765
 
 
2766
875
 
2767
876
def new_by_entry(tt, entry, parent_id, tree):
2768
877
    """Create a new file according to its inventory entry"""
2771
880
    if kind == 'file':
2772
881
        contents = tree.get_file(entry.file_id).readlines()
2773
882
        executable = tree.is_executable(entry.file_id)
2774
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
883
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2775
884
                           executable)
2776
 
    elif kind in ('directory', 'tree-reference'):
2777
 
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2778
 
        if kind == 'tree-reference':
2779
 
            tt.set_tree_reference(entry.reference_revision, trans_id)
2780
 
        return trans_id
 
885
    elif kind == 'directory':
 
886
        return tt.new_directory(name, parent_id, entry.file_id)
2781
887
    elif kind == 'symlink':
2782
888
        target = tree.get_symlink_target(entry.file_id)
2783
889
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2784
 
    else:
2785
 
        raise errors.BadFileKindError(name, kind)
2786
 
 
2787
 
 
2788
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2789
 
    filter_tree_path=None):
2790
 
    """Create new file contents according to tree contents.
2791
 
    
2792
 
    :param filter_tree_path: the tree path to use to lookup
2793
 
      content filters to apply to the bytes output in the working tree.
2794
 
      This only applies if the working tree supports content filtering.
2795
 
    """
2796
 
    kind = tree.kind(file_id)
2797
 
    if kind == 'directory':
 
890
 
 
891
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
892
    """Create new file contents according to an inventory entry."""
 
893
    if entry.kind == "file":
 
894
        if lines == None:
 
895
            lines = tree.get_file(entry.file_id).readlines()
 
896
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
897
    elif entry.kind == "symlink":
 
898
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
899
    elif entry.kind == "directory":
2798
900
        tt.create_directory(trans_id)
2799
 
    elif kind == "file":
2800
 
        if bytes is None:
2801
 
            tree_file = tree.get_file(file_id)
2802
 
            try:
2803
 
                bytes = tree_file.readlines()
2804
 
            finally:
2805
 
                tree_file.close()
2806
 
        wt = tt._tree
2807
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2808
 
            filters = wt._content_filter_stack(filter_tree_path)
2809
 
            bytes = filtered_output_bytes(bytes, filters,
2810
 
                ContentFilterContext(filter_tree_path, tree))
2811
 
        tt.create_file(bytes, trans_id)
2812
 
    elif kind == "symlink":
2813
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2814
 
    else:
2815
 
        raise AssertionError('Unknown kind %r' % kind)
2816
 
 
2817
901
 
2818
902
def create_entry_executability(tt, entry, trans_id):
2819
903
    """Set the executability of a trans_id according to an inventory entry"""
2821
905
        tt.set_executability(entry.executable, trans_id)
2822
906
 
2823
907
 
2824
 
@deprecated_function(deprecated_in((2, 3, 0)))
2825
 
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2826
 
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2827
 
 
2828
 
 
2829
 
@deprecated_function(deprecated_in((2, 3, 0)))
2830
 
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2831
 
    """Produce a backup-style name that appears to be available"""
2832
 
    def name_gen():
2833
 
        counter = 1
2834
 
        while True:
2835
 
            yield "%s.~%d~" % (name, counter)
2836
 
            counter += 1
2837
 
    for new_name in name_gen():
2838
 
        if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2839
 
            return new_name
 
908
def find_interesting(working_tree, target_tree, filenames):
 
909
    """Find the ids corresponding to specified filenames."""
 
910
    if not filenames:
 
911
        interesting_ids = None
 
912
    else:
 
913
        interesting_ids = set()
 
914
        for tree_path in filenames:
 
915
            for tree in (working_tree, target_tree):
 
916
                not_found = True
 
917
                file_id = tree.inventory.path2id(tree_path)
 
918
                if file_id is not None:
 
919
                    interesting_ids.add(file_id)
 
920
                    not_found = False
 
921
                if not_found:
 
922
                    raise NotVersionedError(path=tree_path)
 
923
    return interesting_ids
 
924
 
 
925
 
 
926
def change_entry(tt, file_id, working_tree, target_tree, 
 
927
                 trans_id_file_id, backups, trans_id):
 
928
    """Replace a file_id's contents with those from a target tree."""
 
929
    e_trans_id = trans_id_file_id(file_id)
 
930
    entry = target_tree.inventory[file_id]
 
931
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
 
932
                                                           working_tree)
 
933
    if contents_mod:
 
934
        mode_id = e_trans_id
 
935
        if has_contents:
 
936
            if not backups:
 
937
                tt.delete_contents(e_trans_id)
 
938
            else:
 
939
                parent_trans_id = trans_id_file_id(entry.parent_id)
 
940
                tt.adjust_path(entry.name+"~", parent_trans_id, e_trans_id)
 
941
                tt.unversion_file(e_trans_id)
 
942
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
 
943
                tt.version_file(file_id, e_trans_id)
 
944
                trans_id[file_id] = e_trans_id
 
945
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
 
946
        create_entry_executability(tt, entry, e_trans_id)
 
947
 
 
948
    elif meta_mod:
 
949
        tt.set_executability(entry.executable, e_trans_id)
 
950
    if tt.final_name(e_trans_id) != entry.name:
 
951
        adjust_path  = True
 
952
    else:
 
953
        parent_id = tt.final_parent(e_trans_id)
 
954
        parent_file_id = tt.final_file_id(parent_id)
 
955
        if parent_file_id != entry.parent_id:
 
956
            adjust_path = True
 
957
        else:
 
958
            adjust_path = False
 
959
    if adjust_path:
 
960
        parent_trans_id = trans_id_file_id(entry.parent_id)
 
961
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
2840
962
 
2841
963
 
2842
964
def _entry_changes(file_id, entry, working_tree):
2851
973
    try:
2852
974
        working_kind = working_tree.kind(file_id)
2853
975
        has_contents = True
2854
 
    except NoSuchFile:
 
976
    except OSError, e:
 
977
        if e.errno != errno.ENOENT:
 
978
            raise
2855
979
        has_contents = False
2856
980
        contents_mod = True
2857
981
        meta_mod = False
2858
982
    if has_contents is True:
2859
 
        if entry.kind != working_kind:
 
983
        real_e_kind = entry.kind
 
984
        if real_e_kind == 'root_directory':
 
985
            real_e_kind = 'directory'
 
986
        if real_e_kind != working_kind:
2860
987
            contents_mod, meta_mod = True, False
2861
988
        else:
2862
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
989
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2863
990
                                       working_tree)
2864
991
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2865
992
            cur_entry._forget_tree_state()
2866
993
    return has_contents, contents_mod, meta_mod
2867
994
 
2868
995
 
2869
 
def revert(working_tree, target_tree, filenames, backups=False,
2870
 
           pb=None, change_reporter=None):
 
996
def revert(working_tree, target_tree, filenames, backups=False, 
 
997
           pb=DummyProgress()):
2871
998
    """Revert a working tree's contents to those of a target tree."""
2872
 
    target_tree.lock_read()
2873
 
    pb = ui.ui_factory.nested_progress_bar()
 
999
    interesting_ids = find_interesting(working_tree, target_tree, filenames)
 
1000
    def interesting(file_id):
 
1001
        return interesting_ids is None or file_id in interesting_ids
 
1002
 
2874
1003
    tt = TreeTransform(working_tree, pb)
2875
1004
    try:
2876
 
        pp = ProgressPhase("Revert phase", 3, pb)
2877
 
        conflicts, merge_modified = _prepare_revert_transform(
2878
 
            working_tree, target_tree, tt, filenames, backups, pp)
2879
 
        if change_reporter:
2880
 
            change_reporter = delta._ChangeReporter(
2881
 
                unversioned_filter=working_tree.is_ignored)
2882
 
            delta.report_changes(tt.iter_changes(), change_reporter)
2883
 
        for conflict in conflicts:
2884
 
            trace.warning(unicode(conflict))
2885
 
        pp.next_phase()
 
1005
        trans_id = {}
 
1006
        def trans_id_file_id(file_id):
 
1007
            try:
 
1008
                return trans_id[file_id]
 
1009
            except KeyError:
 
1010
                return tt.trans_id_tree_file_id(file_id)
 
1011
 
 
1012
        sorted_interesting = [i for i in topology_sorted_ids(target_tree) if
 
1013
                              interesting(i)]
 
1014
        for id_num, file_id in enumerate(sorted_interesting):
 
1015
            pb.update("Reverting file", id_num+1, len(sorted_interesting))
 
1016
            if file_id not in working_tree.inventory:
 
1017
                entry = target_tree.inventory[file_id]
 
1018
                parent_id = trans_id_file_id(entry.parent_id)
 
1019
                e_trans_id = new_by_entry(tt, entry, parent_id, target_tree)
 
1020
                trans_id[file_id] = e_trans_id
 
1021
            else:
 
1022
                change_entry(tt, file_id, working_tree, target_tree, 
 
1023
                             trans_id_file_id, backups, trans_id)
 
1024
        wt_interesting = [i for i in working_tree.inventory if interesting(i)]
 
1025
        for id_num, file_id in enumerate(wt_interesting):
 
1026
            pb.update("New file check", id_num+1, len(sorted_interesting))
 
1027
            if file_id not in target_tree:
 
1028
                tt.unversion_file(tt.trans_id_tree_file_id(file_id))
 
1029
        raw_conflicts = resolve_conflicts(tt, pb)
 
1030
        for line in conflicts_strings(cook_conflicts(raw_conflicts, tt)):
 
1031
            warning(line)
2886
1032
        tt.apply()
2887
 
        working_tree.set_merge_modified(merge_modified)
2888
1033
    finally:
2889
 
        target_tree.unlock()
2890
1034
        tt.finalize()
2891
1035
        pb.clear()
2892
 
    return conflicts
2893
 
 
2894
 
 
2895
 
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2896
 
                              backups, pp, basis_tree=None,
2897
 
                              merge_modified=None):
2898
 
    child_pb = ui.ui_factory.nested_progress_bar()
2899
 
    try:
2900
 
        if merge_modified is None:
2901
 
            merge_modified = working_tree.merge_modified()
2902
 
        merge_modified = _alter_files(working_tree, target_tree, tt,
2903
 
                                      child_pb, filenames, backups,
2904
 
                                      merge_modified, basis_tree)
2905
 
    finally:
2906
 
        child_pb.finished()
2907
 
    child_pb = ui.ui_factory.nested_progress_bar()
2908
 
    try:
2909
 
        raw_conflicts = resolve_conflicts(tt, child_pb,
2910
 
            lambda t, c: conflict_pass(t, c, target_tree))
2911
 
    finally:
2912
 
        child_pb.finished()
2913
 
    conflicts = cook_conflicts(raw_conflicts, tt)
2914
 
    return conflicts, merge_modified
2915
 
 
2916
 
 
2917
 
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2918
 
                 backups, merge_modified, basis_tree=None):
2919
 
    if basis_tree is not None:
2920
 
        basis_tree.lock_read()
2921
 
    # We ask the working_tree for its changes relative to the target, rather
2922
 
    # than the target changes relative to the working tree. Because WT4 has an
2923
 
    # optimizer to compare itself to a target, but no optimizer for the
2924
 
    # reverse.
2925
 
    change_list = working_tree.iter_changes(target_tree,
2926
 
        specific_files=specific_files, pb=pb)
2927
 
    if target_tree.get_root_id() is None:
2928
 
        skip_root = True
2929
 
    else:
2930
 
        skip_root = False
2931
 
    try:
2932
 
        deferred_files = []
2933
 
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2934
 
                kind, executable) in enumerate(change_list):
2935
 
            target_path, wt_path = path
2936
 
            target_versioned, wt_versioned = versioned
2937
 
            target_parent, wt_parent = parent
2938
 
            target_name, wt_name = name
2939
 
            target_kind, wt_kind = kind
2940
 
            target_executable, wt_executable = executable
2941
 
            if skip_root and wt_parent is None:
2942
 
                continue
2943
 
            trans_id = tt.trans_id_file_id(file_id)
2944
 
            mode_id = None
2945
 
            if changed_content:
2946
 
                keep_content = False
2947
 
                if wt_kind == 'file' and (backups or target_kind is None):
2948
 
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2949
 
                    if merge_modified.get(file_id) != wt_sha1:
2950
 
                        # acquire the basis tree lazily to prevent the
2951
 
                        # expense of accessing it when it's not needed ?
2952
 
                        # (Guessing, RBC, 200702)
2953
 
                        if basis_tree is None:
2954
 
                            basis_tree = working_tree.basis_tree()
2955
 
                            basis_tree.lock_read()
2956
 
                        if basis_tree.has_id(file_id):
2957
 
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2958
 
                                keep_content = True
2959
 
                        elif target_kind is None and not target_versioned:
2960
 
                            keep_content = True
2961
 
                if wt_kind is not None:
2962
 
                    if not keep_content:
2963
 
                        tt.delete_contents(trans_id)
2964
 
                    elif target_kind is not None:
2965
 
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
2966
 
                        backup_name = tt._available_backup_name(
2967
 
                            wt_name, parent_trans_id)
2968
 
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2969
 
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
2970
 
                        if wt_versioned and target_versioned:
2971
 
                            tt.unversion_file(trans_id)
2972
 
                            tt.version_file(file_id, new_trans_id)
2973
 
                        # New contents should have the same unix perms as old
2974
 
                        # contents
2975
 
                        mode_id = trans_id
2976
 
                        trans_id = new_trans_id
2977
 
                if target_kind in ('directory', 'tree-reference'):
2978
 
                    tt.create_directory(trans_id)
2979
 
                    if target_kind == 'tree-reference':
2980
 
                        revision = target_tree.get_reference_revision(file_id,
2981
 
                                                                      target_path)
2982
 
                        tt.set_tree_reference(revision, trans_id)
2983
 
                elif target_kind == 'symlink':
2984
 
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2985
 
                                      trans_id)
2986
 
                elif target_kind == 'file':
2987
 
                    deferred_files.append((file_id, (trans_id, mode_id)))
2988
 
                    if basis_tree is None:
2989
 
                        basis_tree = working_tree.basis_tree()
2990
 
                        basis_tree.lock_read()
2991
 
                    new_sha1 = target_tree.get_file_sha1(file_id)
2992
 
                    if (basis_tree.has_id(file_id) and
2993
 
                        new_sha1 == basis_tree.get_file_sha1(file_id)):
2994
 
                        if file_id in merge_modified:
2995
 
                            del merge_modified[file_id]
2996
 
                    else:
2997
 
                        merge_modified[file_id] = new_sha1
2998
 
 
2999
 
                    # preserve the execute bit when backing up
3000
 
                    if keep_content and wt_executable == target_executable:
3001
 
                        tt.set_executability(target_executable, trans_id)
3002
 
                elif target_kind is not None:
3003
 
                    raise AssertionError(target_kind)
3004
 
            if not wt_versioned and target_versioned:
3005
 
                tt.version_file(file_id, trans_id)
3006
 
            if wt_versioned and not target_versioned:
3007
 
                tt.unversion_file(trans_id)
3008
 
            if (target_name is not None and
3009
 
                (wt_name != target_name or wt_parent != target_parent)):
3010
 
                if target_name == '' and target_parent is None:
3011
 
                    parent_trans = ROOT_PARENT
3012
 
                else:
3013
 
                    parent_trans = tt.trans_id_file_id(target_parent)
3014
 
                if wt_parent is None and wt_versioned:
3015
 
                    tt.adjust_root_path(target_name, parent_trans)
3016
 
                else:
3017
 
                    tt.adjust_path(target_name, parent_trans, trans_id)
3018
 
            if wt_executable != target_executable and target_kind == "file":
3019
 
                tt.set_executability(target_executable, trans_id)
3020
 
        if working_tree.supports_content_filtering():
3021
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
3022
 
                target_tree.iter_files_bytes(deferred_files)):
3023
 
                file_id = deferred_files[index][0]
3024
 
                # We're reverting a tree to the target tree so using the
3025
 
                # target tree to find the file path seems the best choice
3026
 
                # here IMO - Ian C 27/Oct/2009
3027
 
                filter_tree_path = target_tree.id2path(file_id)
3028
 
                filters = working_tree._content_filter_stack(filter_tree_path)
3029
 
                bytes = filtered_output_bytes(bytes, filters,
3030
 
                    ContentFilterContext(filter_tree_path, working_tree))
3031
 
                tt.create_file(bytes, trans_id, mode_id)
3032
 
        else:
3033
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3034
 
                deferred_files):
3035
 
                tt.create_file(bytes, trans_id, mode_id)
3036
 
        tt.fixup_new_roots()
3037
 
    finally:
3038
 
        if basis_tree is not None:
3039
 
            basis_tree.unlock()
3040
 
    return merge_modified
3041
 
 
3042
 
 
3043
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
1036
 
 
1037
 
 
1038
def resolve_conflicts(tt, pb=DummyProgress()):
3044
1039
    """Make many conflict-resolution attempts, but die if they fail"""
3045
 
    if pass_func is None:
3046
 
        pass_func = conflict_pass
3047
1040
    new_conflicts = set()
3048
 
    pb = ui.ui_factory.nested_progress_bar()
3049
1041
    try:
3050
1042
        for n in range(10):
3051
 
            pb.update(gettext('Resolution pass'), n+1, 10)
 
1043
            pb.update('Resolution pass', n+1, 10)
3052
1044
            conflicts = tt.find_conflicts()
3053
1045
            if len(conflicts) == 0:
3054
1046
                return new_conflicts
3055
 
            new_conflicts.update(pass_func(tt, conflicts))
 
1047
            new_conflicts.update(conflict_pass(tt, conflicts))
3056
1048
        raise MalformedTransform(conflicts=conflicts)
3057
1049
    finally:
3058
 
        pb.finished()
3059
 
 
3060
 
 
3061
 
def conflict_pass(tt, conflicts, path_tree=None):
3062
 
    """Resolve some classes of conflicts.
3063
 
 
3064
 
    :param tt: The transform to resolve conflicts in
3065
 
    :param conflicts: The conflicts to resolve
3066
 
    :param path_tree: A Tree to get supplemental paths from
3067
 
    """
 
1050
        pb.clear()
 
1051
 
 
1052
 
 
1053
def conflict_pass(tt, conflicts):
 
1054
    """Resolve some classes of conflicts."""
3068
1055
    new_conflicts = set()
3069
1056
    for c_type, conflict in ((c[0], c) for c in conflicts):
3070
1057
        if c_type == 'duplicate id':
3073
1060
                               conflict[1], conflict[2], ))
3074
1061
        elif c_type == 'duplicate':
3075
1062
            # files that were renamed take precedence
 
1063
            new_name = tt.final_name(conflict[1])+'.moved'
3076
1064
            final_parent = tt.final_parent(conflict[1])
3077
1065
            if tt.path_changed(conflict[1]):
3078
 
                existing_file, new_file = conflict[2], conflict[1]
 
1066
                tt.adjust_path(new_name, final_parent, conflict[2])
 
1067
                new_conflicts.add((c_type, 'Moved existing file to', 
 
1068
                                   conflict[2], conflict[1]))
3079
1069
            else:
3080
 
                existing_file, new_file = conflict[1], conflict[2]
3081
 
            new_name = tt.final_name(existing_file)+'.moved'
3082
 
            tt.adjust_path(new_name, final_parent, existing_file)
3083
 
            new_conflicts.add((c_type, 'Moved existing file to',
3084
 
                               existing_file, new_file))
 
1070
                tt.adjust_path(new_name, final_parent, conflict[1])
 
1071
                new_conflicts.add((c_type, 'Moved existing file to', 
 
1072
                                  conflict[1], conflict[2]))
3085
1073
        elif c_type == 'parent loop':
3086
1074
            # break the loop by undoing one of the ops that caused the loop
3087
1075
            cur = conflict[1]
3090
1078
            new_conflicts.add((c_type, 'Cancelled move', cur,
3091
1079
                               tt.final_parent(cur),))
3092
1080
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3093
 
 
 
1081
            
3094
1082
        elif c_type == 'missing parent':
3095
1083
            trans_id = conflict[1]
3096
 
            if trans_id in tt._removed_contents:
3097
 
                cancel_deletion = True
3098
 
                orphans = tt._get_potential_orphans(trans_id)
3099
 
                if orphans:
3100
 
                    cancel_deletion = False
3101
 
                    # All children are orphans
3102
 
                    for o in orphans:
3103
 
                        try:
3104
 
                            tt.new_orphan(o, trans_id)
3105
 
                        except OrphaningError:
3106
 
                            # Something bad happened so we cancel the directory
3107
 
                            # deletion which will leave it in place with a
3108
 
                            # conflict. The user can deal with it from there.
3109
 
                            # Note that this also catch the case where we don't
3110
 
                            # want to create orphans and leave the directory in
3111
 
                            # place.
3112
 
                            cancel_deletion = True
3113
 
                            break
3114
 
                if cancel_deletion:
3115
 
                    # Cancel the directory deletion
3116
 
                    tt.cancel_deletion(trans_id)
3117
 
                    new_conflicts.add(('deleting parent', 'Not deleting',
3118
 
                                       trans_id))
3119
 
            else:
3120
 
                create = True
3121
 
                try:
3122
 
                    tt.final_name(trans_id)
3123
 
                except NoFinalPath:
3124
 
                    if path_tree is not None:
3125
 
                        file_id = tt.final_file_id(trans_id)
3126
 
                        if file_id is None:
3127
 
                            file_id = tt.inactive_file_id(trans_id)
3128
 
                        _, entry = path_tree.iter_entries_by_dir(
3129
 
                            [file_id]).next()
3130
 
                        # special-case the other tree root (move its
3131
 
                        # children to current root)
3132
 
                        if entry.parent_id is None:
3133
 
                            create = False
3134
 
                            moved = _reparent_transform_children(
3135
 
                                tt, trans_id, tt.root)
3136
 
                            for child in moved:
3137
 
                                new_conflicts.add((c_type, 'Moved to root',
3138
 
                                                   child))
3139
 
                        else:
3140
 
                            parent_trans_id = tt.trans_id_file_id(
3141
 
                                entry.parent_id)
3142
 
                            tt.adjust_path(entry.name, parent_trans_id,
3143
 
                                           trans_id)
3144
 
                if create:
3145
 
                    tt.create_directory(trans_id)
3146
 
                    new_conflicts.add((c_type, 'Created directory', trans_id))
 
1084
            try:
 
1085
                tt.cancel_deletion(trans_id)
 
1086
                new_conflicts.add((c_type, 'Not deleting', trans_id))
 
1087
            except KeyError:
 
1088
                tt.create_directory(trans_id)
 
1089
                new_conflicts.add((c_type, 'Created directory.', trans_id))
3147
1090
        elif c_type == 'unversioned parent':
3148
 
            file_id = tt.inactive_file_id(conflict[1])
3149
 
            # special-case the other tree root (move its children instead)
3150
 
            if path_tree and path_tree.has_id(file_id):
3151
 
                if path_tree.path2id('') == file_id:
3152
 
                    # This is the root entry, skip it
3153
 
                    continue
3154
 
            tt.version_file(file_id, conflict[1])
 
1091
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
3155
1092
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3156
 
        elif c_type == 'non-directory parent':
3157
 
            parent_id = conflict[1]
3158
 
            parent_parent = tt.final_parent(parent_id)
3159
 
            parent_name = tt.final_name(parent_id)
3160
 
            parent_file_id = tt.final_file_id(parent_id)
3161
 
            new_parent_id = tt.new_directory(parent_name + '.new',
3162
 
                parent_parent, parent_file_id)
3163
 
            _reparent_transform_children(tt, parent_id, new_parent_id)
3164
 
            if parent_file_id is not None:
3165
 
                tt.unversion_file(parent_id)
3166
 
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
3167
 
        elif c_type == 'versioning no contents':
3168
 
            tt.cancel_versioning(conflict[1])
3169
1093
    return new_conflicts
3170
1094
 
3171
 
 
3172
1095
def cook_conflicts(raw_conflicts, tt):
3173
1096
    """Generate a list of cooked conflicts, sorted by file path"""
3174
 
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3175
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
1097
    def key(conflict):
 
1098
        if conflict[2] is not None:
 
1099
            return conflict[2], conflict[0]
 
1100
        elif len(conflict) == 6:
 
1101
            return conflict[4], conflict[0]
 
1102
        else:
 
1103
            return None, conflict[0]
3176
1104
 
 
1105
    return sorted(list(iter_cook_conflicts(raw_conflicts, tt)), key=key)
3177
1106
 
3178
1107
def iter_cook_conflicts(raw_conflicts, tt):
 
1108
    cooked_conflicts = []
3179
1109
    fp = FinalPaths(tt)
3180
1110
    for conflict in raw_conflicts:
3181
1111
        c_type = conflict[0]
3183
1113
        modified_path = fp.get_path(conflict[2])
3184
1114
        modified_id = tt.final_file_id(conflict[2])
3185
1115
        if len(conflict) == 3:
3186
 
            yield conflicts.Conflict.factory(
3187
 
                c_type, action=action, path=modified_path, file_id=modified_id)
3188
 
 
 
1116
            yield c_type, action, modified_path, modified_id
3189
1117
        else:
3190
1118
            conflicting_path = fp.get_path(conflict[3])
3191
1119
            conflicting_id = tt.final_file_id(conflict[3])
3192
 
            yield conflicts.Conflict.factory(
3193
 
                c_type, action=action, path=modified_path,
3194
 
                file_id=modified_id,
3195
 
                conflict_path=conflicting_path,
3196
 
                conflict_file_id=conflicting_id)
3197
 
 
3198
 
 
3199
 
class _FileMover(object):
3200
 
    """Moves and deletes files for TreeTransform, tracking operations"""
3201
 
 
3202
 
    def __init__(self):
3203
 
        self.past_renames = []
3204
 
        self.pending_deletions = []
3205
 
 
3206
 
    def rename(self, from_, to):
3207
 
        """Rename a file from one path to another."""
3208
 
        try:
3209
 
            os.rename(from_, to)
3210
 
        except OSError, e:
3211
 
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3212
 
                raise errors.FileExists(to, str(e))
3213
 
            # normal OSError doesn't include filenames so it's hard to see where
3214
 
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3215
 
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3216
 
        self.past_renames.append((from_, to))
3217
 
 
3218
 
    def pre_delete(self, from_, to):
3219
 
        """Rename a file out of the way and mark it for deletion.
3220
 
 
3221
 
        Unlike os.unlink, this works equally well for files and directories.
3222
 
        :param from_: The current file path
3223
 
        :param to: A temporary path for the file
3224
 
        """
3225
 
        self.rename(from_, to)
3226
 
        self.pending_deletions.append(to)
3227
 
 
3228
 
    def rollback(self):
3229
 
        """Reverse all renames that have been performed"""
3230
 
        for from_, to in reversed(self.past_renames):
3231
 
            try:
3232
 
                os.rename(to, from_)
3233
 
            except OSError, e:
3234
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3235
 
        # after rollback, don't reuse _FileMover
3236
 
        past_renames = None
3237
 
        pending_deletions = None
3238
 
 
3239
 
    def apply_deletions(self):
3240
 
        """Apply all marked deletions"""
3241
 
        for path in self.pending_deletions:
3242
 
            delete_any(path)
3243
 
        # after apply_deletions, don't reuse _FileMover
3244
 
        past_renames = None
3245
 
        pending_deletions = None
 
1120
            yield (c_type, action, modified_path, modified_id, 
 
1121
                   conflicting_path, conflicting_id)
 
1122
 
 
1123
 
 
1124
def conflicts_strings(conflicts):
 
1125
    """Generate strings for the provided conflicts"""
 
1126
    for conflict in conflicts:
 
1127
        conflict_type = conflict[0]
 
1128
        if conflict_type == 'text conflict':
 
1129
            yield 'Text conflict in %s' % conflict[2]
 
1130
        elif conflict_type == 'contents conflict':
 
1131
            yield 'Contents conflict in %s' % conflict[2]
 
1132
        elif conflict_type == 'path conflict':
 
1133
            yield 'Path conflict: %s / %s' % conflict[2:]
 
1134
        elif conflict_type == 'duplicate id':
 
1135
            vals = (conflict[4], conflict[1], conflict[2])
 
1136
            yield 'Conflict adding id to %s.  %s %s.' % vals
 
1137
        elif conflict_type == 'duplicate':
 
1138
            vals = (conflict[4], conflict[1], conflict[2])
 
1139
            yield 'Conflict adding file %s.  %s %s.' % vals
 
1140
        elif conflict_type == 'parent loop':
 
1141
            vals = (conflict[4], conflict[2], conflict[1])
 
1142
            yield 'Conflict moving %s into %s.  %s.' % vals
 
1143
        elif conflict_type == 'unversioned parent':
 
1144
            vals = (conflict[2], conflict[1])
 
1145
            yield 'Conflict adding versioned files to %s.  %s.' % vals
 
1146
        elif conflict_type == 'missing parent':
 
1147
            vals = (conflict[2], conflict[1])
 
1148
            yield 'Conflict adding files to %s.  %s.' % vals