/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/transform.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2019-06-21 15:50:53 UTC
  • mfrom: (7351.1.1 sphinx-python2)
  • Revision ID: breezy.the.bot@gmail.com-20190621155053-2es28nek48h1xyom
Pin sphinx 1.8.5 for python 2, as newer versions have dropped python 2 support.

Merged from https://code.launchpad.net/~jelmer/brz/sphinx-python2/+merge/369175

Show diffs side-by-side

added added

removed removed

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