/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 bzrlib/transform.py

(gz) Fix bzr mv error report on bzr mv of a removed non-ascii file (Martin
 Packman)

Show diffs side-by-side

added added

removed removed

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