1
# Copyright (C) 2006-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
22
from stat import S_ISREG, S_IEXEC
26
config as _mod_config,
33
lazy_import.lazy_import(globals(), """
44
revision as _mod_revision,
48
from breezy.bzr import (
52
from breezy.i18n import gettext
54
from .errors import (DuplicateKey, MalformedTransform,
55
ReusingTransform, CantMoveRoot,
56
ImmortalLimbo, NoFinalPath)
57
from .filters import filtered_output_bytes, ContentFilterContext
58
from .mutabletree import MutableTree
59
from .osutils import (
67
from .progress import ProgressPhase
74
ROOT_PARENT = "root-parent"
77
def unique_add(map, key, value):
79
raise DuplicateKey(key=key)
83
class _TransformResults(object):
84
def __init__(self, modified_paths, rename_count):
86
self.modified_paths = modified_paths
87
self.rename_count = rename_count
90
class TreeTransformBase(object):
91
"""The base class for TreeTransform and its kin."""
93
def __init__(self, tree, pb=None, case_sensitive=True):
96
:param tree: The tree that will be transformed, but not necessarily
99
:param case_sensitive: If True, the target of the transform is
100
case sensitive, not just case preserving.
102
object.__init__(self)
105
# mapping of trans_id -> new basename
107
# mapping of trans_id -> new parent trans_id
108
self._new_parent = {}
109
# mapping of trans_id with new contents -> new file_kind
110
self._new_contents = {}
111
# mapping of trans_id => (sha1 of content, stat_value)
112
self._observed_sha1s = {}
113
# Set of trans_ids whose contents will be removed
114
self._removed_contents = set()
115
# Mapping of trans_id -> new execute-bit value
116
self._new_executability = {}
117
# Mapping of trans_id -> new tree-reference value
118
self._new_reference_revision = {}
119
# Mapping of trans_id -> new file_id
121
# Mapping of old file-id -> trans_id
122
self._non_present_ids = {}
123
# Mapping of new file_id -> trans_id
125
# Set of trans_ids that will be removed
126
self._removed_id = set()
127
# Mapping of path in old tree -> trans_id
128
self._tree_path_ids = {}
129
# Mapping trans_id -> path in old tree
130
self._tree_id_paths = {}
131
# The trans_id that will be used as the tree root
132
if tree.is_versioned(''):
133
self._new_root = self.trans_id_tree_path('')
135
self._new_root = None
136
# Indicator of whether the transform has been applied
140
# Whether the target is case sensitive
141
self._case_sensitive_target = case_sensitive
142
# A counter of how many files have been renamed
143
self.rename_count = 0
146
"""Support Context Manager API."""
149
def __exit__(self, exc_type, exc_val, exc_tb):
150
"""Support Context Manager API."""
154
"""Release the working tree lock, if held.
156
This is required if apply has not been invoked, but can be invoked
159
if self._tree is None:
161
for hook in MutableTree.hooks['post_transform']:
162
hook(self._tree, self)
166
def __get_root(self):
167
return self._new_root
169
root = property(__get_root)
171
def _assign_id(self):
172
"""Produce a new tranform id"""
173
new_id = "new-%s" % self._id_number
177
def create_path(self, name, parent):
178
"""Assign a transaction id to a new path"""
179
trans_id = self._assign_id()
180
unique_add(self._new_name, trans_id, name)
181
unique_add(self._new_parent, trans_id, parent)
184
def adjust_path(self, name, parent, trans_id):
185
"""Change the path that is assigned to a transaction id."""
187
raise ValueError("Parent trans-id may not be None")
188
if trans_id == self._new_root:
190
self._new_name[trans_id] = name
191
self._new_parent[trans_id] = parent
193
def adjust_root_path(self, name, parent):
194
"""Emulate moving the root by moving all children, instead.
196
We do this by undoing the association of root's transaction id with the
197
current tree. This allows us to create a new directory with that
198
transaction id. We unversion the root directory and version the
199
physically new directory, and hope someone versions the tree root
202
old_root = self._new_root
203
old_root_file_id = self.final_file_id(old_root)
204
# force moving all children of root
205
for child_id in self.iter_tree_children(old_root):
206
if child_id != parent:
207
self.adjust_path(self.final_name(child_id),
208
self.final_parent(child_id), child_id)
209
file_id = self.final_file_id(child_id)
210
if file_id is not None:
211
self.unversion_file(child_id)
212
self.version_file(file_id, child_id)
214
# the physical root needs a new transaction id
215
self._tree_path_ids.pop("")
216
self._tree_id_paths.pop(old_root)
217
self._new_root = self.trans_id_tree_path('')
218
if parent == old_root:
219
parent = self._new_root
220
self.adjust_path(name, parent, old_root)
221
self.create_directory(old_root)
222
self.version_file(old_root_file_id, old_root)
223
self.unversion_file(self._new_root)
225
def fixup_new_roots(self):
226
"""Reinterpret requests to change the root directory
228
Instead of creating a root directory, or moving an existing directory,
229
all the attributes and children of the new root are applied to the
230
existing root directory.
232
This means that the old root trans-id becomes obsolete, so it is
233
recommended only to invoke this after the root trans-id has become
237
new_roots = [k for k, v in self._new_parent.items()
239
if len(new_roots) < 1:
241
if len(new_roots) != 1:
242
raise ValueError('A tree cannot have two roots!')
243
if self._new_root is None:
244
self._new_root = new_roots[0]
246
old_new_root = new_roots[0]
247
# unversion the new root's directory.
248
if self.final_kind(self._new_root) is None:
249
file_id = self.final_file_id(old_new_root)
251
file_id = self.final_file_id(self._new_root)
252
if old_new_root in self._new_id:
253
self.cancel_versioning(old_new_root)
255
self.unversion_file(old_new_root)
256
# if, at this stage, root still has an old file_id, zap it so we can
257
# stick a new one in.
258
if (self.tree_file_id(self._new_root) is not None
259
and self._new_root not in self._removed_id):
260
self.unversion_file(self._new_root)
261
if file_id is not None:
262
self.version_file(file_id, self._new_root)
264
# Now move children of new root into old root directory.
265
# Ensure all children are registered with the transaction, but don't
266
# use directly-- some tree children have new parents
267
list(self.iter_tree_children(old_new_root))
268
# Move all children of new root into old root directory.
269
for child in self.by_parent().get(old_new_root, []):
270
self.adjust_path(self.final_name(child), self._new_root, child)
272
# Ensure old_new_root has no directory.
273
if old_new_root in self._new_contents:
274
self.cancel_creation(old_new_root)
276
self.delete_contents(old_new_root)
278
# prevent deletion of root directory.
279
if self._new_root in self._removed_contents:
280
self.cancel_deletion(self._new_root)
282
# destroy path info for old_new_root.
283
del self._new_parent[old_new_root]
284
del self._new_name[old_new_root]
286
def trans_id_file_id(self, file_id):
287
"""Determine or set the transaction id associated with a file ID.
288
A new id is only created for file_ids that were never present. If
289
a transaction has been unversioned, it is deliberately still returned.
290
(this will likely lead to an unversioned parent conflict.)
293
raise ValueError('None is not a valid file id')
294
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
295
return self._r_new_id[file_id]
298
path = self._tree.id2path(file_id)
299
except errors.NoSuchId:
300
if file_id in self._non_present_ids:
301
return self._non_present_ids[file_id]
303
trans_id = self._assign_id()
304
self._non_present_ids[file_id] = trans_id
307
return self.trans_id_tree_path(path)
309
def trans_id_tree_path(self, path):
310
"""Determine (and maybe set) the transaction ID for a tree path."""
311
path = self.canonical_path(path)
312
if path not in self._tree_path_ids:
313
self._tree_path_ids[path] = self._assign_id()
314
self._tree_id_paths[self._tree_path_ids[path]] = path
315
return self._tree_path_ids[path]
317
def get_tree_parent(self, trans_id):
318
"""Determine id of the parent in the tree."""
319
path = self._tree_id_paths[trans_id]
322
return self.trans_id_tree_path(os.path.dirname(path))
324
def delete_contents(self, trans_id):
325
"""Schedule the contents of a path entry for deletion"""
326
kind = self.tree_kind(trans_id)
328
self._removed_contents.add(trans_id)
330
def cancel_deletion(self, trans_id):
331
"""Cancel a scheduled deletion"""
332
self._removed_contents.remove(trans_id)
334
def unversion_file(self, trans_id):
335
"""Schedule a path entry to become unversioned"""
336
self._removed_id.add(trans_id)
338
def delete_versioned(self, trans_id):
339
"""Delete and unversion a versioned file"""
340
self.delete_contents(trans_id)
341
self.unversion_file(trans_id)
343
def set_executability(self, executability, trans_id):
344
"""Schedule setting of the 'execute' bit
345
To unschedule, set to None
347
if executability is None:
348
del self._new_executability[trans_id]
350
unique_add(self._new_executability, trans_id, executability)
352
def set_tree_reference(self, revision_id, trans_id):
353
"""Set the reference associated with a directory"""
354
unique_add(self._new_reference_revision, trans_id, revision_id)
356
def version_file(self, file_id, trans_id):
357
"""Schedule a file to become versioned."""
360
unique_add(self._new_id, trans_id, file_id)
361
unique_add(self._r_new_id, file_id, trans_id)
363
def cancel_versioning(self, trans_id):
364
"""Undo a previous versioning of a file"""
365
file_id = self._new_id[trans_id]
366
del self._new_id[trans_id]
367
del self._r_new_id[file_id]
369
def new_paths(self, filesystem_only=False):
370
"""Determine the paths of all new and changed files.
372
:param filesystem_only: if True, only calculate values for files
373
that require renames or execute bit changes.
377
stale_ids = self._needs_rename.difference(self._new_name)
378
stale_ids.difference_update(self._new_parent)
379
stale_ids.difference_update(self._new_contents)
380
stale_ids.difference_update(self._new_id)
381
needs_rename = self._needs_rename.difference(stale_ids)
382
id_sets = (needs_rename, self._new_executability)
384
id_sets = (self._new_name, self._new_parent, self._new_contents,
385
self._new_id, self._new_executability)
386
for id_set in id_sets:
387
new_ids.update(id_set)
388
return sorted(FinalPaths(self).get_paths(new_ids))
390
def _inventory_altered(self):
391
"""Determine which trans_ids need new Inventory entries.
393
An new entry is needed when anything that would be reflected by an
394
inventory entry changes, including file name, file_id, parent file_id,
395
file kind, and the execute bit.
397
Some care is taken to return entries with real changes, not cases
398
where the value is deleted and then restored to its original value,
399
but some actually unchanged values may be returned.
401
:returns: A list of (path, trans_id) for all items requiring an
402
inventory change. Ordered by path.
405
# Find entries whose file_ids are new (or changed).
406
new_file_id = set(t for t in self._new_id
407
if self._new_id[t] != self.tree_file_id(t))
408
for id_set in [self._new_name, self._new_parent, new_file_id,
409
self._new_executability]:
410
changed_ids.update(id_set)
411
# removing implies a kind change
412
changed_kind = set(self._removed_contents)
414
changed_kind.intersection_update(self._new_contents)
415
# Ignore entries that are already known to have changed.
416
changed_kind.difference_update(changed_ids)
417
# to keep only the truly changed ones
418
changed_kind = (t for t in changed_kind
419
if self.tree_kind(t) != self.final_kind(t))
420
# all kind changes will alter the inventory
421
changed_ids.update(changed_kind)
422
# To find entries with changed parent_ids, find parents which existed,
423
# but changed file_id.
424
# Now add all their children to the set.
425
for parent_trans_id in new_file_id:
426
changed_ids.update(self.iter_tree_children(parent_trans_id))
427
return sorted(FinalPaths(self).get_paths(changed_ids))
429
def final_kind(self, trans_id):
430
"""Determine the final file kind, after any changes applied.
432
:return: None if the file does not exist/has no contents. (It is
433
conceivable that a path would be created without the corresponding
434
contents insertion command)
436
if trans_id in self._new_contents:
437
return self._new_contents[trans_id]
438
elif trans_id in self._removed_contents:
441
return self.tree_kind(trans_id)
443
def tree_path(self, trans_id):
444
"""Determine the tree path associated with the trans_id."""
445
return self._tree_id_paths.get(trans_id)
447
def tree_file_id(self, trans_id):
448
"""Determine the file id associated with the trans_id in the tree"""
449
path = self.tree_path(trans_id)
452
# the file is old; the old id is still valid
453
if self._new_root == trans_id:
454
return self._tree.path2id('')
455
return self._tree.path2id(path)
457
def final_file_id(self, trans_id):
458
"""Determine the file id after any changes are applied, or None.
460
None indicates that the file will not be versioned after changes are
464
return self._new_id[trans_id]
466
if trans_id in self._removed_id:
468
return self.tree_file_id(trans_id)
470
def inactive_file_id(self, trans_id):
471
"""Return the inactive file_id associated with a transaction id.
472
That is, the one in the tree or in non_present_ids.
473
The file_id may actually be active, too.
475
file_id = self.tree_file_id(trans_id)
476
if file_id is not None:
478
for key, value in self._non_present_ids.items():
479
if value == trans_id:
482
def final_parent(self, trans_id):
483
"""Determine the parent file_id, after any changes are applied.
485
ROOT_PARENT is returned for the tree root.
488
return self._new_parent[trans_id]
490
return self.get_tree_parent(trans_id)
492
def final_name(self, trans_id):
493
"""Determine the final filename, after all changes are applied."""
495
return self._new_name[trans_id]
498
return os.path.basename(self._tree_id_paths[trans_id])
500
raise NoFinalPath(trans_id, self)
503
"""Return a map of parent: children for known parents.
505
Only new paths and parents of tree files with assigned ids are used.
508
items = list(self._new_parent.items())
509
items.extend((t, self.final_parent(t))
510
for t in list(self._tree_id_paths))
511
for trans_id, parent_id in items:
512
if parent_id not in by_parent:
513
by_parent[parent_id] = set()
514
by_parent[parent_id].add(trans_id)
517
def path_changed(self, trans_id):
518
"""Return True if a trans_id's path has changed."""
519
return (trans_id in self._new_name) or (trans_id in self._new_parent)
521
def new_contents(self, trans_id):
522
return (trans_id in self._new_contents)
524
def find_conflicts(self):
525
"""Find any violations of inventory or filesystem invariants"""
526
if self._done is True:
527
raise ReusingTransform()
529
# ensure all children of all existent parents are known
530
# all children of non-existent parents are known, by definition.
531
self._add_tree_children()
532
by_parent = self.by_parent()
533
conflicts.extend(self._unversioned_parents(by_parent))
534
conflicts.extend(self._parent_loops())
535
conflicts.extend(self._duplicate_entries(by_parent))
536
conflicts.extend(self._duplicate_ids())
537
conflicts.extend(self._parent_type_conflicts(by_parent))
538
conflicts.extend(self._improper_versioning())
539
conflicts.extend(self._executability_conflicts())
540
conflicts.extend(self._overwrite_conflicts())
543
def _check_malformed(self):
544
conflicts = self.find_conflicts()
545
if len(conflicts) != 0:
546
raise MalformedTransform(conflicts=conflicts)
548
def _add_tree_children(self):
549
"""Add all the children of all active parents to the known paths.
551
Active parents are those which gain children, and those which are
552
removed. This is a necessary first step in detecting conflicts.
554
parents = list(self.by_parent())
555
parents.extend([t for t in self._removed_contents if
556
self.tree_kind(t) == 'directory'])
557
for trans_id in self._removed_id:
558
path = self.tree_path(trans_id)
560
if self._tree.stored_kind(path) == 'directory':
561
parents.append(trans_id)
562
elif self.tree_kind(trans_id) == 'directory':
563
parents.append(trans_id)
565
for parent_id in parents:
566
# ensure that all children are registered with the transaction
567
list(self.iter_tree_children(parent_id))
569
def _has_named_child(self, name, parent_id, known_children):
570
"""Does a parent already have a name child.
572
:param name: The searched for name.
574
:param parent_id: The parent for which the check is made.
576
:param known_children: The already known children. This should have
577
been recently obtained from `self.by_parent.get(parent_id)`
578
(or will be if None is passed).
580
if known_children is None:
581
known_children = self.by_parent().get(parent_id, [])
582
for child in known_children:
583
if self.final_name(child) == name:
585
parent_path = self._tree_id_paths.get(parent_id, None)
586
if parent_path is None:
587
# No parent... no children
589
child_path = joinpath(parent_path, name)
590
child_id = self._tree_path_ids.get(child_path, None)
592
# Not known by the tree transform yet, check the filesystem
593
return osutils.lexists(self._tree.abspath(child_path))
595
raise AssertionError('child_id is missing: %s, %s, %s'
596
% (name, parent_id, child_id))
598
def _available_backup_name(self, name, target_id):
599
"""Find an available backup name.
601
:param name: The basename of the file.
603
:param target_id: The directory trans_id where the backup should
606
known_children = self.by_parent().get(target_id, [])
607
return osutils.available_backup_name(
609
lambda base: self._has_named_child(
610
base, target_id, known_children))
612
def _parent_loops(self):
613
"""No entry should be its own ancestor"""
615
for trans_id in self._new_parent:
618
while parent_id != ROOT_PARENT:
621
parent_id = self.final_parent(parent_id)
624
if parent_id == trans_id:
625
conflicts.append(('parent loop', trans_id))
626
if parent_id in seen:
630
def _unversioned_parents(self, by_parent):
631
"""If parent directories are versioned, children must be versioned."""
633
for parent_id, children in by_parent.items():
634
if parent_id == ROOT_PARENT:
636
if self.final_file_id(parent_id) is not None:
638
for child_id in children:
639
if self.final_file_id(child_id) is not None:
640
conflicts.append(('unversioned parent', parent_id))
644
def _improper_versioning(self):
645
"""Cannot version a file with no contents, or a bad type.
647
However, existing entries with no contents are okay.
650
for trans_id in self._new_id:
651
kind = self.final_kind(trans_id)
652
if kind == 'symlink' and not self._tree.supports_symlinks():
653
# Ignore symlinks as they are not supported on this platform
656
conflicts.append(('versioning no contents', trans_id))
658
if not self._tree.versionable_kind(kind):
659
conflicts.append(('versioning bad kind', trans_id, kind))
662
def _executability_conflicts(self):
663
"""Check for bad executability changes.
665
Only versioned files may have their executability set, because
666
1. only versioned entries can have executability under windows
667
2. only files can be executable. (The execute bit on a directory
668
does not indicate searchability)
671
for trans_id in self._new_executability:
672
if self.final_file_id(trans_id) is None:
673
conflicts.append(('unversioned executability', trans_id))
675
if self.final_kind(trans_id) != "file":
676
conflicts.append(('non-file executability', trans_id))
679
def _overwrite_conflicts(self):
680
"""Check for overwrites (not permitted on Win32)"""
682
for trans_id in self._new_contents:
683
if self.tree_kind(trans_id) is None:
685
if trans_id not in self._removed_contents:
686
conflicts.append(('overwrite', trans_id,
687
self.final_name(trans_id)))
690
def _duplicate_entries(self, by_parent):
691
"""No directory may have two entries with the same name."""
693
if (self._new_name, self._new_parent) == ({}, {}):
695
for children in by_parent.values():
697
for child_tid in children:
698
name = self.final_name(child_tid)
700
# Keep children only if they still exist in the end
701
if not self._case_sensitive_target:
703
name_ids.append((name, child_tid))
707
for name, trans_id in name_ids:
708
kind = self.final_kind(trans_id)
709
file_id = self.final_file_id(trans_id)
710
if kind is None and file_id is None:
712
if name == last_name:
713
conflicts.append(('duplicate', last_trans_id, trans_id,
716
last_trans_id = trans_id
719
def _duplicate_ids(self):
720
"""Each inventory id may only be used once"""
723
all_ids = self._tree.all_file_ids()
724
except errors.UnsupportedOperation:
725
# it's okay for non-file-id trees to raise UnsupportedOperation.
727
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
729
active_tree_ids = all_ids.difference(removed_tree_ids)
730
for trans_id, file_id in self._new_id.items():
731
if file_id in active_tree_ids:
732
path = self._tree.id2path(file_id)
733
old_trans_id = self.trans_id_tree_path(path)
734
conflicts.append(('duplicate id', old_trans_id, trans_id))
737
def _parent_type_conflicts(self, by_parent):
738
"""Children must have a directory parent"""
740
for parent_id, children in by_parent.items():
741
if parent_id == ROOT_PARENT:
744
for child_id in children:
745
if self.final_kind(child_id) is not None:
750
# There is at least a child, so we need an existing directory to
752
kind = self.final_kind(parent_id)
754
# The directory will be deleted
755
conflicts.append(('missing parent', parent_id))
756
elif kind != "directory":
757
# Meh, we need a *directory* to put something in it
758
conflicts.append(('non-directory parent', parent_id))
761
def _set_executability(self, path, trans_id):
762
"""Set the executability of versioned files """
763
if self._tree._supports_executable():
764
new_executability = self._new_executability[trans_id]
765
abspath = self._tree.abspath(path)
766
current_mode = os.stat(abspath).st_mode
767
if new_executability:
770
to_mode = current_mode | (0o100 & ~umask)
771
# Enable x-bit for others only if they can read it.
772
if current_mode & 0o004:
773
to_mode |= 0o001 & ~umask
774
if current_mode & 0o040:
775
to_mode |= 0o010 & ~umask
777
to_mode = current_mode & ~0o111
778
osutils.chmod_if_possible(abspath, to_mode)
780
def _new_entry(self, name, parent_id, file_id):
781
"""Helper function to create a new filesystem entry."""
782
trans_id = self.create_path(name, parent_id)
783
if file_id is not None:
784
self.version_file(file_id, trans_id)
787
def new_file(self, name, parent_id, contents, file_id=None,
788
executable=None, sha1=None):
789
"""Convenience method to create files.
791
name is the name of the file to create.
792
parent_id is the transaction id of the parent directory of the file.
793
contents is an iterator of bytestrings, which will be used to produce
795
:param file_id: The inventory ID of the file, if it is to be versioned.
796
:param executable: Only valid when a file_id has been supplied.
798
trans_id = self._new_entry(name, parent_id, file_id)
799
# TODO: rather than scheduling a set_executable call,
800
# have create_file create the file with the right mode.
801
self.create_file(contents, trans_id, sha1=sha1)
802
if executable is not None:
803
self.set_executability(executable, trans_id)
806
def new_directory(self, name, parent_id, file_id=None):
807
"""Convenience method to create directories.
809
name is the name of the directory to create.
810
parent_id is the transaction id of the parent directory of the
812
file_id is the inventory ID of the directory, if it is to be versioned.
814
trans_id = self._new_entry(name, parent_id, file_id)
815
self.create_directory(trans_id)
818
def new_symlink(self, name, parent_id, target, file_id=None):
819
"""Convenience method to create symbolic link.
821
name is the name of the symlink to create.
822
parent_id is the transaction id of the parent directory of the symlink.
823
target is a bytestring of the target of the symlink.
824
file_id is the inventory ID of the file, if it is to be versioned.
826
trans_id = self._new_entry(name, parent_id, file_id)
827
self.create_symlink(target, trans_id)
830
def new_orphan(self, trans_id, parent_id):
831
"""Schedule an item to be orphaned.
833
When a directory is about to be removed, its children, if they are not
834
versioned are moved out of the way: they don't have a parent anymore.
836
:param trans_id: The trans_id of the existing item.
837
:param parent_id: The parent trans_id of the item.
839
raise NotImplementedError(self.new_orphan)
841
def _get_potential_orphans(self, dir_id):
842
"""Find the potential orphans in a directory.
844
A directory can't be safely deleted if there are versioned files in it.
845
If all the contained files are unversioned then they can be orphaned.
847
The 'None' return value means that the directory contains at least one
848
versioned file and should not be deleted.
850
:param dir_id: The directory trans id.
852
:return: A list of the orphan trans ids or None if at least one
853
versioned file is present.
856
# Find the potential orphans, stop if one item should be kept
857
for child_tid in self.by_parent()[dir_id]:
858
if child_tid in self._removed_contents:
859
# The child is removed as part of the transform. Since it was
860
# versioned before, it's not an orphan
862
elif self.final_file_id(child_tid) is None:
863
# The child is not versioned
864
orphans.append(child_tid)
866
# We have a versioned file here, searching for orphans is
872
def _affected_ids(self):
873
"""Return the set of transform ids affected by the transform"""
874
trans_ids = set(self._removed_id)
875
trans_ids.update(self._new_id)
876
trans_ids.update(self._removed_contents)
877
trans_ids.update(self._new_contents)
878
trans_ids.update(self._new_executability)
879
trans_ids.update(self._new_name)
880
trans_ids.update(self._new_parent)
883
def _get_file_id_maps(self):
884
"""Return mapping of file_ids to trans_ids in the to and from states"""
885
trans_ids = self._affected_ids()
888
# Build up two dicts: trans_ids associated with file ids in the
889
# FROM state, vs the TO state.
890
for trans_id in trans_ids:
891
from_file_id = self.tree_file_id(trans_id)
892
if from_file_id is not None:
893
from_trans_ids[from_file_id] = trans_id
894
to_file_id = self.final_file_id(trans_id)
895
if to_file_id is not None:
896
to_trans_ids[to_file_id] = trans_id
897
return from_trans_ids, to_trans_ids
899
def _from_file_data(self, from_trans_id, from_versioned, from_path):
900
"""Get data about a file in the from (tree) state
902
Return a (name, parent, kind, executable) tuple
904
from_path = self._tree_id_paths.get(from_trans_id)
906
# get data from working tree if versioned
907
from_entry = next(self._tree.iter_entries_by_dir(
908
specific_files=[from_path]))[1]
909
from_name = from_entry.name
910
from_parent = from_entry.parent_id
913
if from_path is None:
914
# File does not exist in FROM state
918
# File exists, but is not versioned. Have to use path-
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)
928
from_executable = False
929
return from_name, from_parent, from_kind, from_executable
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
934
Return a (name, parent, kind, executable) tuple
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
944
to_executable = False
945
return to_name, to_parent, to_kind, to_executable
947
def iter_changes(self):
948
"""Produce output in the same format as Tree.iter_changes.
950
Will produce nonsensical results if invoked while inventory/filesystem
951
conflicts (as reported by TreeTransform.find_conflicts()) are present.
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.
957
final_paths = FinalPaths(self)
958
from_trans_ids, to_trans_ids = self._get_file_id_maps()
960
# Now iterate through all active file_ids
961
for file_id in set(from_trans_ids).union(to_trans_ids):
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]
969
from_versioned = True
970
to_trans_id = to_trans_ids.get(file_id)
971
if to_trans_id is None:
973
to_trans_id = from_trans_id
977
if not from_versioned:
980
from_path = self._tree_id_paths.get(from_trans_id)
984
to_path = final_paths.get_path(to_trans_id)
986
from_name, from_parent, from_kind, from_executable = \
987
self._from_file_data(from_trans_id, from_versioned, from_path)
989
to_name, to_parent, to_kind, to_executable = \
990
self._to_file_data(to_trans_id, from_trans_id, from_executable)
992
if from_kind != to_kind:
994
elif to_kind in ('file', 'symlink') and (
995
to_trans_id != from_trans_id
996
or to_trans_id in self._new_contents):
998
if (not modified and from_versioned == to_versioned
999
and from_parent == to_parent and from_name == to_name
1000
and from_executable == to_executable):
1004
file_id, (from_path, to_path), modified,
1005
(from_versioned, to_versioned),
1006
(from_parent, to_parent),
1007
(from_name, to_name),
1008
(from_kind, to_kind),
1009
(from_executable, to_executable)))
1012
return (c.path[0] or '', c.path[1] or '')
1013
return iter(sorted(results, key=path_key))
1015
def get_preview_tree(self):
1016
"""Return a tree representing the result of the transform.
1018
The tree is a snapshot, and altering the TreeTransform will invalidate
1021
return _PreviewTree(self)
1023
def commit(self, branch, message, merge_parents=None, strict=False,
1024
timestamp=None, timezone=None, committer=None, authors=None,
1025
revprops=None, revision_id=None):
1026
"""Commit the result of this TreeTransform to a branch.
1028
:param branch: The branch to commit to.
1029
:param message: The message to attach to the commit.
1030
:param merge_parents: Additional parent revision-ids specified by
1032
:param strict: If True, abort the commit if there are unversioned
1034
:param timestamp: if not None, seconds-since-epoch for the time and
1035
date. (May be a float.)
1036
:param timezone: Optional timezone for timestamp, as an offset in
1038
:param committer: Optional committer in email-id format.
1039
(e.g. "J Random Hacker <jrandom@example.com>")
1040
:param authors: Optional list of authors in email-id format.
1041
:param revprops: Optional dictionary of revision properties.
1042
:param revision_id: Optional revision id. (Specifying a revision-id
1043
may reduce performance for some non-native formats.)
1044
:return: The revision_id of the revision committed.
1046
self._check_malformed()
1048
unversioned = set(self._new_contents).difference(set(self._new_id))
1049
for trans_id in unversioned:
1050
if self.final_file_id(trans_id) is None:
1051
raise errors.StrictCommitFailed()
1053
revno, last_rev_id = branch.last_revision_info()
1054
if last_rev_id == _mod_revision.NULL_REVISION:
1055
if merge_parents is not None:
1056
raise ValueError('Cannot supply merge parents for first'
1060
parent_ids = [last_rev_id]
1061
if merge_parents is not None:
1062
parent_ids.extend(merge_parents)
1063
if self._tree.get_revision_id() != last_rev_id:
1064
raise ValueError('TreeTransform not based on branch basis: %s' %
1065
self._tree.get_revision_id().decode('utf-8'))
1066
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1067
builder = branch.get_commit_builder(parent_ids,
1068
timestamp=timestamp,
1070
committer=committer,
1072
revision_id=revision_id)
1073
preview = self.get_preview_tree()
1074
list(builder.record_iter_changes(preview, last_rev_id,
1075
self.iter_changes()))
1076
builder.finish_inventory()
1077
revision_id = builder.commit(message)
1078
branch.set_last_revision_info(revno + 1, revision_id)
1081
def _text_parent(self, trans_id):
1082
path = self.tree_path(trans_id)
1084
if path is None or self._tree.kind(path) != 'file':
1086
except errors.NoSuchFile:
1090
def _get_parents_texts(self, trans_id):
1091
"""Get texts for compression parents of this file."""
1092
path = self._text_parent(trans_id)
1095
return (self._tree.get_file_text(path),)
1097
def _get_parents_lines(self, trans_id):
1098
"""Get lines for compression parents of this file."""
1099
path = self._text_parent(trans_id)
1102
return (self._tree.get_file_lines(path),)
1104
def serialize(self, serializer):
1105
"""Serialize this TreeTransform.
1107
:param serializer: A Serialiser like pack.ContainerSerializer.
1109
new_name = {k.encode('utf-8'): v.encode('utf-8')
1110
for k, v in self._new_name.items()}
1111
new_parent = {k.encode('utf-8'): v.encode('utf-8')
1112
for k, v in self._new_parent.items()}
1113
new_id = {k.encode('utf-8'): v
1114
for k, v in self._new_id.items()}
1115
new_executability = {k.encode('utf-8'): int(v)
1116
for k, v in self._new_executability.items()}
1117
tree_path_ids = {k.encode('utf-8'): v.encode('utf-8')
1118
for k, v in self._tree_path_ids.items()}
1119
non_present_ids = {k: v.encode('utf-8')
1120
for k, v in self._non_present_ids.items()}
1121
removed_contents = [trans_id.encode('utf-8')
1122
for trans_id in self._removed_contents]
1123
removed_id = [trans_id.encode('utf-8')
1124
for trans_id in self._removed_id]
1126
b'_id_number': self._id_number,
1127
b'_new_name': new_name,
1128
b'_new_parent': new_parent,
1129
b'_new_executability': new_executability,
1131
b'_tree_path_ids': tree_path_ids,
1132
b'_removed_id': removed_id,
1133
b'_removed_contents': removed_contents,
1134
b'_non_present_ids': non_present_ids,
1136
yield serializer.bytes_record(bencode.bencode(attribs),
1138
for trans_id, kind in sorted(self._new_contents.items()):
1140
with open(self._limbo_name(trans_id), 'rb') as cur_file:
1141
lines = cur_file.readlines()
1142
parents = self._get_parents_lines(trans_id)
1143
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1144
content = b''.join(mpdiff.to_patch())
1145
if kind == 'directory':
1147
if kind == 'symlink':
1148
content = self._read_symlink_target(trans_id)
1149
if not isinstance(content, bytes):
1150
content = content.encode('utf-8')
1151
yield serializer.bytes_record(
1152
content, ((trans_id.encode('utf-8'), kind.encode('ascii')),))
1154
def deserialize(self, records):
1155
"""Deserialize a stored TreeTransform.
1157
:param records: An iterable of (names, content) tuples, as per
1158
pack.ContainerPushParser.
1160
names, content = next(records)
1161
attribs = bencode.bdecode(content)
1162
self._id_number = attribs[b'_id_number']
1163
self._new_name = {k.decode('utf-8'): v.decode('utf-8')
1164
for k, v in attribs[b'_new_name'].items()}
1165
self._new_parent = {k.decode('utf-8'): v.decode('utf-8')
1166
for k, v in attribs[b'_new_parent'].items()}
1167
self._new_executability = {
1168
k.decode('utf-8'): bool(v)
1169
for k, v in attribs[b'_new_executability'].items()}
1170
self._new_id = {k.decode('utf-8'): v
1171
for k, v in attribs[b'_new_id'].items()}
1172
self._r_new_id = {v: k for k, v in self._new_id.items()}
1173
self._tree_path_ids = {}
1174
self._tree_id_paths = {}
1175
for bytepath, trans_id in attribs[b'_tree_path_ids'].items():
1176
path = bytepath.decode('utf-8')
1177
trans_id = trans_id.decode('utf-8')
1178
self._tree_path_ids[path] = trans_id
1179
self._tree_id_paths[trans_id] = path
1180
self._removed_id = {trans_id.decode('utf-8')
1181
for trans_id in attribs[b'_removed_id']}
1182
self._removed_contents = set(
1183
trans_id.decode('utf-8')
1184
for trans_id in attribs[b'_removed_contents'])
1185
self._non_present_ids = {
1186
k: v.decode('utf-8')
1187
for k, v in attribs[b'_non_present_ids'].items()}
1188
for ((trans_id, kind),), content in records:
1189
trans_id = trans_id.decode('utf-8')
1190
kind = kind.decode('ascii')
1192
mpdiff = multiparent.MultiParent.from_patch(content)
1193
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1194
self.create_file(lines, trans_id)
1195
if kind == 'directory':
1196
self.create_directory(trans_id)
1197
if kind == 'symlink':
1198
self.create_symlink(content.decode('utf-8'), trans_id)
1200
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1201
"""Schedule creation of a new file.
1205
:param contents: an iterator of strings, all of which will be written
1206
to the target destination.
1207
:param trans_id: TreeTransform handle
1208
:param mode_id: If not None, force the mode of the target file to match
1209
the mode of the object referenced by mode_id.
1210
Otherwise, we will try to preserve mode bits of an existing file.
1211
:param sha1: If the sha1 of this content is already known, pass it in.
1212
We can use it to prevent future sha1 computations.
1214
raise NotImplementedError(self.create_file)
1216
def create_directory(self, trans_id):
1217
"""Schedule creation of a new directory.
1219
See also new_directory.
1221
raise NotImplementedError(self.create_directory)
1223
def create_symlink(self, target, trans_id):
1224
"""Schedule creation of a new symbolic link.
1226
target is a bytestring.
1227
See also new_symlink.
1229
raise NotImplementedError(self.create_symlink)
1231
def create_hardlink(self, path, trans_id):
1232
"""Schedule creation of a hard link"""
1233
raise NotImplementedError(self.create_hardlink)
1235
def cancel_creation(self, trans_id):
1236
"""Cancel the creation of new file contents."""
1237
raise NotImplementedError(self.cancel_creation)
1240
class DiskTreeTransform(TreeTransformBase):
1241
"""Tree transform storing its contents on disk."""
1243
def __init__(self, tree, limbodir, pb=None, case_sensitive=True):
1245
:param tree: The tree that will be transformed, but not necessarily
1247
:param limbodir: A directory where new files can be stored until
1248
they are installed in their proper places
1250
:param case_sensitive: If True, the target of the transform is
1251
case sensitive, not just case preserving.
1253
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1254
self._limbodir = limbodir
1255
self._deletiondir = None
1256
# A mapping of transform ids to their limbo filename
1257
self._limbo_files = {}
1258
self._possibly_stale_limbo_files = set()
1259
# A mapping of transform ids to a set of the transform ids of children
1260
# that their limbo directory has
1261
self._limbo_children = {}
1262
# Map transform ids to maps of child filename to child transform id
1263
self._limbo_children_names = {}
1264
# List of transform ids that need to be renamed from limbo into place
1265
self._needs_rename = set()
1266
self._creation_mtime = None
1267
self._create_symlinks = osutils.supports_symlinks(self._limbodir)
1270
"""Release the working tree lock, if held, clean up limbo dir.
1272
This is required if apply has not been invoked, but can be invoked
1275
if self._tree is None:
1278
limbo_paths = list(self._limbo_files.values())
1279
limbo_paths.extend(self._possibly_stale_limbo_files)
1280
limbo_paths.sort(reverse=True)
1281
for path in limbo_paths:
1284
except OSError as e:
1285
if e.errno != errno.ENOENT:
1287
# XXX: warn? perhaps we just got interrupted at an
1288
# inconvenient moment, but perhaps files are disappearing
1291
delete_any(self._limbodir)
1293
# We don't especially care *why* the dir is immortal.
1294
raise ImmortalLimbo(self._limbodir)
1296
if self._deletiondir is not None:
1297
delete_any(self._deletiondir)
1299
raise errors.ImmortalPendingDeletion(self._deletiondir)
1301
TreeTransformBase.finalize(self)
1303
def _limbo_supports_executable(self):
1304
"""Check if the limbo path supports the executable bit."""
1305
return osutils.supports_executable(self._limbodir)
1307
def _limbo_name(self, trans_id):
1308
"""Generate the limbo name of a file"""
1309
limbo_name = self._limbo_files.get(trans_id)
1310
if limbo_name is None:
1311
limbo_name = self._generate_limbo_path(trans_id)
1312
self._limbo_files[trans_id] = limbo_name
1315
def _generate_limbo_path(self, trans_id):
1316
"""Generate a limbo path using the trans_id as the relative path.
1318
This is suitable as a fallback, and when the transform should not be
1319
sensitive to the path encoding of the limbo directory.
1321
self._needs_rename.add(trans_id)
1322
return pathjoin(self._limbodir, trans_id)
1324
def adjust_path(self, name, parent, trans_id):
1325
previous_parent = self._new_parent.get(trans_id)
1326
previous_name = self._new_name.get(trans_id)
1327
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1328
if (trans_id in self._limbo_files
1329
and trans_id not in self._needs_rename):
1330
self._rename_in_limbo([trans_id])
1331
if previous_parent != parent:
1332
self._limbo_children[previous_parent].remove(trans_id)
1333
if previous_parent != parent or previous_name != name:
1334
del self._limbo_children_names[previous_parent][previous_name]
1336
def _rename_in_limbo(self, trans_ids):
1337
"""Fix limbo names so that the right final path is produced.
1339
This means we outsmarted ourselves-- we tried to avoid renaming
1340
these files later by creating them with their final names in their
1341
final parents. But now the previous name or parent is no longer
1342
suitable, so we have to rename them.
1344
Even for trans_ids that have no new contents, we must remove their
1345
entries from _limbo_files, because they are now stale.
1347
for trans_id in trans_ids:
1348
old_path = self._limbo_files[trans_id]
1349
self._possibly_stale_limbo_files.add(old_path)
1350
del self._limbo_files[trans_id]
1351
if trans_id not in self._new_contents:
1353
new_path = self._limbo_name(trans_id)
1354
os.rename(old_path, new_path)
1355
self._possibly_stale_limbo_files.remove(old_path)
1356
for descendant in self._limbo_descendants(trans_id):
1357
desc_path = self._limbo_files[descendant]
1358
desc_path = new_path + desc_path[len(old_path):]
1359
self._limbo_files[descendant] = desc_path
1361
def _limbo_descendants(self, trans_id):
1362
"""Return the set of trans_ids whose limbo paths descend from this."""
1363
descendants = set(self._limbo_children.get(trans_id, []))
1364
for descendant in list(descendants):
1365
descendants.update(self._limbo_descendants(descendant))
1368
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1369
"""Schedule creation of a new file.
1373
:param contents: an iterator of strings, all of which will be written
1374
to the target destination.
1375
:param trans_id: TreeTransform handle
1376
:param mode_id: If not None, force the mode of the target file to match
1377
the mode of the object referenced by mode_id.
1378
Otherwise, we will try to preserve mode bits of an existing file.
1379
:param sha1: If the sha1 of this content is already known, pass it in.
1380
We can use it to prevent future sha1 computations.
1382
name = self._limbo_name(trans_id)
1383
with open(name, 'wb') as f:
1384
unique_add(self._new_contents, trans_id, 'file')
1385
f.writelines(contents)
1386
self._set_mtime(name)
1387
self._set_mode(trans_id, mode_id, S_ISREG)
1388
# It is unfortunate we have to use lstat instead of fstat, but we just
1389
# used utime and chmod on the file, so we need the accurate final
1391
if sha1 is not None:
1392
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1394
def _read_symlink_target(self, trans_id):
1395
return os.readlink(self._limbo_name(trans_id))
1397
def _set_mtime(self, path):
1398
"""All files that are created get the same mtime.
1400
This time is set by the first object to be created.
1402
if self._creation_mtime is None:
1403
self._creation_mtime = time.time()
1404
os.utime(path, (self._creation_mtime, self._creation_mtime))
1406
def create_hardlink(self, path, trans_id):
1407
"""Schedule creation of a hard link"""
1408
name = self._limbo_name(trans_id)
1411
except OSError as e:
1412
if e.errno != errno.EPERM:
1414
raise errors.HardLinkNotSupported(path)
1416
unique_add(self._new_contents, trans_id, 'file')
1417
except BaseException:
1418
# Clean up the file, it never got registered so
1419
# TreeTransform.finalize() won't clean it up.
1423
def create_directory(self, trans_id):
1424
"""Schedule creation of a new directory.
1426
See also new_directory.
1428
os.mkdir(self._limbo_name(trans_id))
1429
unique_add(self._new_contents, trans_id, 'directory')
1431
def create_symlink(self, target, trans_id):
1432
"""Schedule creation of a new symbolic link.
1434
target is a bytestring.
1435
See also new_symlink.
1437
if self._create_symlinks:
1438
os.symlink(target, self._limbo_name(trans_id))
1441
path = FinalPaths(self).get_path(trans_id)
1445
'Unable to create symlink "%s" on this filesystem.' % (path,))
1446
# We add symlink to _new_contents even if they are unsupported
1447
# and not created. These entries are subsequently used to avoid
1448
# conflicts on platforms that don't support symlink
1449
unique_add(self._new_contents, trans_id, 'symlink')
1451
def cancel_creation(self, trans_id):
1452
"""Cancel the creation of new file contents."""
1453
del self._new_contents[trans_id]
1454
if trans_id in self._observed_sha1s:
1455
del self._observed_sha1s[trans_id]
1456
children = self._limbo_children.get(trans_id)
1457
# if this is a limbo directory with children, move them before removing
1459
if children is not None:
1460
self._rename_in_limbo(children)
1461
del self._limbo_children[trans_id]
1462
del self._limbo_children_names[trans_id]
1463
delete_any(self._limbo_name(trans_id))
1465
def new_orphan(self, trans_id, parent_id):
1466
conf = self._tree.get_config_stack()
1467
handle_orphan = conf.get('transform.orphan_policy')
1468
handle_orphan(self, trans_id, parent_id)
1471
class OrphaningError(errors.BzrError):
1473
# Only bugs could lead to such exception being seen by the user
1474
internal_error = True
1475
_fmt = "Error while orphaning %s in %s directory"
1477
def __init__(self, orphan, parent):
1478
errors.BzrError.__init__(self)
1479
self.orphan = orphan
1480
self.parent = parent
1483
class OrphaningForbidden(OrphaningError):
1485
_fmt = "Policy: %s doesn't allow creating orphans."
1487
def __init__(self, policy):
1488
errors.BzrError.__init__(self)
1489
self.policy = policy
1492
def move_orphan(tt, orphan_id, parent_id):
1493
"""See TreeTransformBase.new_orphan.
1495
This creates a new orphan in the `brz-orphans` dir at the root of the
1498
:param tt: The TreeTransform orphaning `trans_id`.
1500
:param orphan_id: The trans id that should be orphaned.
1502
:param parent_id: The orphan parent trans id.
1504
# Add the orphan dir if it doesn't exist
1505
orphan_dir_basename = 'brz-orphans'
1506
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1507
if tt.final_kind(od_id) is None:
1508
tt.create_directory(od_id)
1509
parent_path = tt._tree_id_paths[parent_id]
1510
# Find a name that doesn't exist yet in the orphan dir
1511
actual_name = tt.final_name(orphan_id)
1512
new_name = tt._available_backup_name(actual_name, od_id)
1513
tt.adjust_path(new_name, od_id, orphan_id)
1514
trace.warning('%s has been orphaned in %s'
1515
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1518
def refuse_orphan(tt, orphan_id, parent_id):
1519
"""See TreeTransformBase.new_orphan.
1521
This refuses to create orphan, letting the caller handle the conflict.
1523
raise OrphaningForbidden('never')
1526
orphaning_registry = registry.Registry()
1527
orphaning_registry.register(
1528
u'conflict', refuse_orphan,
1529
'Leave orphans in place and create a conflict on the directory.')
1530
orphaning_registry.register(
1531
u'move', move_orphan,
1532
'Move orphans into the brz-orphans directory.')
1533
orphaning_registry._set_default_key(u'conflict')
1536
opt_transform_orphan = _mod_config.RegistryOption(
1537
'transform.orphan_policy', orphaning_registry,
1538
help='Policy for orphaned files during transform operations.',
1542
class TreeTransform(DiskTreeTransform):
1543
"""Represent a tree transformation.
1545
This object is designed to support incremental generation of the transform,
1548
However, it gives optimum performance when parent directories are created
1549
before their contents. The transform is then able to put child files
1550
directly in their parent directory, avoiding later renames.
1552
It is easy to produce malformed transforms, but they are generally
1553
harmless. Attempting to apply a malformed transform will cause an
1554
exception to be raised before any modifications are made to the tree.
1556
Many kinds of malformed transforms can be corrected with the
1557
resolve_conflicts function. The remaining ones indicate programming error,
1558
such as trying to create a file with no path.
1560
Two sets of file creation methods are supplied. Convenience methods are:
1565
These are composed of the low-level methods:
1567
* create_file or create_directory or create_symlink
1571
Transform/Transaction ids
1572
-------------------------
1573
trans_ids are temporary ids assigned to all files involved in a transform.
1574
It's possible, even common, that not all files in the Tree have trans_ids.
1576
trans_ids are used because filenames and file_ids are not good enough
1577
identifiers; filenames change, and not all files have file_ids. File-ids
1578
are also associated with trans-ids, so that moving a file moves its
1581
trans_ids are only valid for the TreeTransform that generated them.
1585
Limbo is a temporary directory use to hold new versions of files.
1586
Files are added to limbo by create_file, create_directory, create_symlink,
1587
and their convenience variants (new_*). Files may be removed from limbo
1588
using cancel_creation. Files are renamed from limbo into their final
1589
location as part of TreeTransform.apply
1591
Limbo must be cleaned up, by either calling TreeTransform.apply or
1592
calling TreeTransform.finalize.
1594
Files are placed into limbo inside their parent directories, where
1595
possible. This reduces subsequent renames, and makes operations involving
1596
lots of files faster. This optimization is only possible if the parent
1597
directory is created *before* creating any of its children, so avoid
1598
creating children before parents, where possible.
1602
This temporary directory is used by _FileMover for storing files that are
1603
about to be deleted. In case of rollback, the files will be restored.
1604
FileMover does not delete files until it is sure that a rollback will not
1608
def __init__(self, tree, pb=None):
1609
"""Note: a tree_write lock is taken on the tree.
1611
Use TreeTransform.finalize() to release the lock (can be omitted if
1612
TreeTransform.apply() called).
1614
tree.lock_tree_write()
1616
limbodir = urlutils.local_path_from_url(
1617
tree._transport.abspath('limbo'))
1618
osutils.ensure_empty_directory_exists(
1620
errors.ExistingLimbo)
1621
deletiondir = urlutils.local_path_from_url(
1622
tree._transport.abspath('pending-deletion'))
1623
osutils.ensure_empty_directory_exists(
1625
errors.ExistingPendingDeletion)
1626
except BaseException:
1630
# Cache of realpath results, to speed up canonical_path
1631
self._realpaths = {}
1632
# Cache of relpath results, to speed up canonical_path
1634
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1635
tree.case_sensitive)
1636
self._deletiondir = deletiondir
1638
def canonical_path(self, path):
1639
"""Get the canonical tree-relative path"""
1640
# don't follow final symlinks
1641
abs = self._tree.abspath(path)
1642
if abs in self._relpaths:
1643
return self._relpaths[abs]
1644
dirname, basename = os.path.split(abs)
1645
if dirname not in self._realpaths:
1646
self._realpaths[dirname] = os.path.realpath(dirname)
1647
dirname = self._realpaths[dirname]
1648
abs = pathjoin(dirname, basename)
1649
if dirname in self._relpaths:
1650
relpath = pathjoin(self._relpaths[dirname], basename)
1651
relpath = relpath.rstrip('/\\')
1653
relpath = self._tree.relpath(abs)
1654
self._relpaths[abs] = relpath
1657
def tree_kind(self, trans_id):
1658
"""Determine the file kind in the working tree.
1660
:returns: The file kind or None if the file does not exist
1662
path = self._tree_id_paths.get(trans_id)
1666
return file_kind(self._tree.abspath(path))
1667
except errors.NoSuchFile:
1670
def _set_mode(self, trans_id, mode_id, typefunc):
1671
"""Set the mode of new file contents.
1672
The mode_id is the existing file to get the mode from (often the same
1673
as trans_id). The operation is only performed if there's a mode match
1674
according to typefunc.
1679
old_path = self._tree_id_paths[mode_id]
1683
mode = os.stat(self._tree.abspath(old_path)).st_mode
1684
except OSError as e:
1685
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1686
# Either old_path doesn't exist, or the parent of the
1687
# target is not a directory (but will be one eventually)
1688
# Either way, we know it doesn't exist *right now*
1689
# See also bug #248448
1694
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1696
def iter_tree_children(self, parent_id):
1697
"""Iterate through the entry's tree children, if any"""
1699
path = self._tree_id_paths[parent_id]
1703
children = os.listdir(self._tree.abspath(path))
1704
except OSError as e:
1705
if not (osutils._is_error_enotdir(e) or
1706
e.errno in (errno.ENOENT, errno.ESRCH)):
1710
for child in children:
1711
childpath = joinpath(path, child)
1712
if self._tree.is_control_filename(childpath):
1714
yield self.trans_id_tree_path(childpath)
1716
def _generate_limbo_path(self, trans_id):
1717
"""Generate a limbo path using the final path if possible.
1719
This optimizes the performance of applying the tree transform by
1720
avoiding renames. These renames can be avoided only when the parent
1721
directory is already scheduled for creation.
1723
If the final path cannot be used, falls back to using the trans_id as
1726
parent = self._new_parent.get(trans_id)
1727
# if the parent directory is already in limbo (e.g. when building a
1728
# tree), choose a limbo name inside the parent, to reduce further
1730
use_direct_path = False
1731
if self._new_contents.get(parent) == 'directory':
1732
filename = self._new_name.get(trans_id)
1733
if filename is not None:
1734
if parent not in self._limbo_children:
1735
self._limbo_children[parent] = set()
1736
self._limbo_children_names[parent] = {}
1737
use_direct_path = True
1738
# the direct path can only be used if no other file has
1739
# already taken this pathname, i.e. if the name is unused, or
1740
# if it is already associated with this trans_id.
1741
elif self._case_sensitive_target:
1742
if (self._limbo_children_names[parent].get(filename)
1743
in (trans_id, None)):
1744
use_direct_path = True
1746
for l_filename, l_trans_id in (
1747
self._limbo_children_names[parent].items()):
1748
if l_trans_id == trans_id:
1750
if l_filename.lower() == filename.lower():
1753
use_direct_path = True
1755
if not use_direct_path:
1756
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1758
limbo_name = pathjoin(self._limbo_files[parent], filename)
1759
self._limbo_children[parent].add(trans_id)
1760
self._limbo_children_names[parent][filename] = trans_id
1763
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1764
"""Apply all changes to the inventory and filesystem.
1766
If filesystem or inventory conflicts are present, MalformedTransform
1769
If apply succeeds, finalize is not necessary.
1771
:param no_conflicts: if True, the caller guarantees there are no
1772
conflicts, so no check is made.
1773
:param precomputed_delta: An inventory delta to use instead of
1775
:param _mover: Supply an alternate FileMover, for testing
1777
for hook in MutableTree.hooks['pre_transform']:
1778
hook(self._tree, self)
1779
if not no_conflicts:
1780
self._check_malformed()
1781
with ui.ui_factory.nested_progress_bar() as child_pb:
1782
if precomputed_delta is None:
1783
child_pb.update(gettext('Apply phase'), 0, 2)
1784
inventory_delta = self._generate_inventory_delta()
1787
inventory_delta = precomputed_delta
1790
mover = _FileMover()
1794
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1795
self._apply_removals(mover)
1796
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1797
modified_paths = self._apply_insertions(mover)
1798
except BaseException:
1802
mover.apply_deletions()
1803
if self.final_file_id(self.root) is None:
1804
inventory_delta = [e for e in inventory_delta if e[0] != '']
1805
self._tree.apply_inventory_delta(inventory_delta)
1806
self._apply_observed_sha1s()
1809
return _TransformResults(modified_paths, self.rename_count)
1811
def _generate_inventory_delta(self):
1812
"""Generate an inventory delta for the current transform."""
1813
inventory_delta = []
1814
new_paths = self._inventory_altered()
1815
total_entries = len(new_paths) + len(self._removed_id)
1816
with ui.ui_factory.nested_progress_bar() as child_pb:
1817
for num, trans_id in enumerate(self._removed_id):
1819
child_pb.update(gettext('removing file'),
1821
if trans_id == self._new_root:
1822
file_id = self._tree.path2id('')
1824
file_id = self.tree_file_id(trans_id)
1825
# File-id isn't really being deleted, just moved
1826
if file_id in self._r_new_id:
1828
path = self._tree_id_paths[trans_id]
1829
inventory_delta.append((path, None, file_id, None))
1830
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1832
for num, (path, trans_id) in enumerate(new_paths):
1834
child_pb.update(gettext('adding file'),
1835
num + len(self._removed_id), total_entries)
1836
file_id = new_path_file_ids[trans_id]
1839
kind = self.final_kind(trans_id)
1841
kind = self._tree.stored_kind(self._tree.id2path(file_id))
1842
parent_trans_id = self.final_parent(trans_id)
1843
parent_file_id = new_path_file_ids.get(parent_trans_id)
1844
if parent_file_id is None:
1845
parent_file_id = self.final_file_id(parent_trans_id)
1846
if trans_id in self._new_reference_revision:
1847
new_entry = inventory.TreeReference(
1849
self._new_name[trans_id],
1850
self.final_file_id(self._new_parent[trans_id]),
1851
None, self._new_reference_revision[trans_id])
1853
new_entry = inventory.make_entry(kind,
1854
self.final_name(trans_id),
1855
parent_file_id, file_id)
1857
old_path = self._tree.id2path(new_entry.file_id)
1858
except errors.NoSuchId:
1860
new_executability = self._new_executability.get(trans_id)
1861
if new_executability is not None:
1862
new_entry.executable = new_executability
1863
inventory_delta.append(
1864
(old_path, path, new_entry.file_id, new_entry))
1865
return inventory_delta
1867
def _apply_removals(self, mover):
1868
"""Perform tree operations that remove directory/inventory names.
1870
That is, delete files that are to be deleted, and put any files that
1871
need renaming into limbo. This must be done in strict child-to-parent
1874
If inventory_delta is None, no inventory delta generation is performed.
1876
tree_paths = sorted(self._tree_path_ids.items(), reverse=True)
1877
with ui.ui_factory.nested_progress_bar() as child_pb:
1878
for num, (path, trans_id) in enumerate(tree_paths):
1879
# do not attempt to move root into a subdirectory of itself.
1882
child_pb.update(gettext('removing file'), num, len(tree_paths))
1883
full_path = self._tree.abspath(path)
1884
if trans_id in self._removed_contents:
1885
delete_path = os.path.join(self._deletiondir, trans_id)
1886
mover.pre_delete(full_path, delete_path)
1887
elif (trans_id in self._new_name or
1888
trans_id in self._new_parent):
1890
mover.rename(full_path, self._limbo_name(trans_id))
1891
except errors.TransformRenameFailed as e:
1892
if e.errno != errno.ENOENT:
1895
self.rename_count += 1
1897
def _apply_insertions(self, mover):
1898
"""Perform tree operations that insert directory/inventory names.
1900
That is, create any files that need to be created, and restore from
1901
limbo any files that needed renaming. This must be done in strict
1902
parent-to-child order.
1904
If inventory_delta is None, no inventory delta is calculated, and
1905
no list of modified paths is returned.
1907
new_paths = self.new_paths(filesystem_only=True)
1909
with ui.ui_factory.nested_progress_bar() as child_pb:
1910
for num, (path, trans_id) in enumerate(new_paths):
1912
child_pb.update(gettext('adding file'),
1913
num, len(new_paths))
1914
full_path = self._tree.abspath(path)
1915
if trans_id in self._needs_rename:
1917
mover.rename(self._limbo_name(trans_id), full_path)
1918
except errors.TransformRenameFailed as e:
1919
# We may be renaming a dangling inventory id
1920
if e.errno != errno.ENOENT:
1923
self.rename_count += 1
1924
# TODO: if trans_id in self._observed_sha1s, we should
1925
# re-stat the final target, since ctime will be
1926
# updated by the change.
1927
if (trans_id in self._new_contents
1928
or self.path_changed(trans_id)):
1929
if trans_id in self._new_contents:
1930
modified_paths.append(full_path)
1931
if trans_id in self._new_executability:
1932
self._set_executability(path, trans_id)
1933
if trans_id in self._observed_sha1s:
1934
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1935
st = osutils.lstat(full_path)
1936
self._observed_sha1s[trans_id] = (o_sha1, st)
1937
for path, trans_id in new_paths:
1938
# new_paths includes stuff like workingtree conflicts. Only the
1939
# stuff in new_contents actually comes from limbo.
1940
if trans_id in self._limbo_files:
1941
del self._limbo_files[trans_id]
1942
self._new_contents.clear()
1943
return modified_paths
1945
def _apply_observed_sha1s(self):
1946
"""After we have finished renaming everything, update observed sha1s
1948
This has to be done after self._tree.apply_inventory_delta, otherwise
1949
it doesn't know anything about the files we are updating. Also, we want
1950
to do this as late as possible, so that most entries end up cached.
1952
# TODO: this doesn't update the stat information for directories. So
1953
# the first 'bzr status' will still need to rewrite
1954
# .bzr/checkout/dirstate. However, we at least don't need to
1955
# re-read all of the files.
1956
# TODO: If the operation took a while, we could do a time.sleep(3) here
1957
# to allow the clock to tick over and ensure we won't have any
1958
# problems. (we could observe start time, and finish time, and if
1959
# it is less than eg 10% overhead, add a sleep call.)
1960
paths = FinalPaths(self)
1961
for trans_id, observed in self._observed_sha1s.items():
1962
path = paths.get_path(trans_id)
1963
self._tree._observed_sha1(path, observed)
1966
class TransformPreview(DiskTreeTransform):
1967
"""A TreeTransform for generating preview trees.
1969
Unlike TreeTransform, this version works when the input tree is a
1970
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1971
unversioned files in the input tree.
1974
def __init__(self, tree, pb=None, case_sensitive=True):
1976
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1977
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1979
def canonical_path(self, path):
1982
def tree_kind(self, trans_id):
1983
path = self._tree_id_paths.get(trans_id)
1986
kind = self._tree.path_content_summary(path)[0]
1987
if kind == 'missing':
1991
def _set_mode(self, trans_id, mode_id, typefunc):
1992
"""Set the mode of new file contents.
1993
The mode_id is the existing file to get the mode from (often the same
1994
as trans_id). The operation is only performed if there's a mode match
1995
according to typefunc.
1997
# is it ok to ignore this? probably
2000
def iter_tree_children(self, parent_id):
2001
"""Iterate through the entry's tree children, if any"""
2003
path = self._tree_id_paths[parent_id]
2007
entry = next(self._tree.iter_entries_by_dir(
2008
specific_files=[path]))[1]
2009
except StopIteration:
2011
children = getattr(entry, 'children', {})
2012
for child in children:
2013
childpath = joinpath(path, child)
2014
yield self.trans_id_tree_path(childpath)
2016
def new_orphan(self, trans_id, parent_id):
2017
raise NotImplementedError(self.new_orphan)
2020
class _PreviewTree(inventorytree.InventoryTree):
2021
"""Partial implementation of Tree to support show_diff_trees"""
2023
def __init__(self, transform):
2024
self._transform = transform
2025
self._final_paths = FinalPaths(transform)
2026
self.__by_parent = None
2027
self._parent_ids = []
2028
self._all_children_cache = {}
2029
self._path2trans_id_cache = {}
2030
self._final_name_cache = {}
2031
self._iter_changes_cache = dict((c.file_id, c) for c in
2032
self._transform.iter_changes())
2034
def supports_tree_reference(self):
2035
# TODO(jelmer): Support tree references in _PreviewTree.
2036
# return self._transform._tree.supports_tree_reference()
2039
def _content_change(self, file_id):
2040
"""Return True if the content of this file changed"""
2041
changes = self._iter_changes_cache.get(file_id)
2042
return (changes is not None and changes.changed_content)
2044
def _get_repository(self):
2045
repo = getattr(self._transform._tree, '_repository', None)
2047
repo = self._transform._tree.branch.repository
2050
def _iter_parent_trees(self):
2051
for revision_id in self.get_parent_ids():
2053
yield self.revision_tree(revision_id)
2054
except errors.NoSuchRevisionInTree:
2055
yield self._get_repository().revision_tree(revision_id)
2057
def _get_file_revision(self, path, file_id, vf, tree_revision):
2059
(file_id, t.get_file_revision(t.id2path(file_id)))
2060
for t in self._iter_parent_trees()]
2061
vf.add_lines((file_id, tree_revision), parent_keys,
2062
self.get_file_lines(path))
2063
repo = self._get_repository()
2064
base_vf = repo.texts
2065
if base_vf not in vf.fallback_versionedfiles:
2066
vf.fallback_versionedfiles.append(base_vf)
2067
return tree_revision
2069
def _stat_limbo_file(self, trans_id):
2070
name = self._transform._limbo_name(trans_id)
2071
return os.lstat(name)
2074
def _by_parent(self):
2075
if self.__by_parent is None:
2076
self.__by_parent = self._transform.by_parent()
2077
return self.__by_parent
2079
def _comparison_data(self, entry, path):
2080
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2081
if kind == 'missing':
2085
file_id = self._transform.final_file_id(self._path2trans_id(path))
2086
executable = self.is_executable(path)
2087
return kind, executable, None
2089
def is_locked(self):
2092
def lock_read(self):
2093
# Perhaps in theory, this should lock the TreeTransform?
2094
return lock.LogicalLockResult(self.unlock)
2100
def root_inventory(self):
2101
"""This Tree does not use inventory as its backing data."""
2102
raise NotImplementedError(_PreviewTree.root_inventory)
2104
def all_file_ids(self):
2105
tree_ids = set(self._transform._tree.all_file_ids())
2106
tree_ids.difference_update(self._transform.tree_file_id(t)
2107
for t in self._transform._removed_id)
2108
tree_ids.update(self._transform._new_id.values())
2111
def all_versioned_paths(self):
2112
tree_paths = set(self._transform._tree.all_versioned_paths())
2114
tree_paths.difference_update(
2115
self._transform.trans_id_tree_path(t)
2116
for t in self._transform._removed_id)
2119
self._final_paths._determine_path(t)
2120
for t in self._transform._new_id)
2124
def _path2trans_id(self, path):
2125
# We must not use None here, because that is a valid value to store.
2126
trans_id = self._path2trans_id_cache.get(path, object)
2127
if trans_id is not object:
2129
segments = splitpath(path)
2130
cur_parent = self._transform.root
2131
for cur_segment in segments:
2132
for child in self._all_children(cur_parent):
2133
final_name = self._final_name_cache.get(child)
2134
if final_name is None:
2135
final_name = self._transform.final_name(child)
2136
self._final_name_cache[child] = final_name
2137
if final_name == cur_segment:
2141
self._path2trans_id_cache[path] = None
2143
self._path2trans_id_cache[path] = cur_parent
2146
def path2id(self, path):
2147
if isinstance(path, list):
2150
path = osutils.pathjoin(*path)
2151
return self._transform.final_file_id(self._path2trans_id(path))
2153
def id2path(self, file_id, recurse='down'):
2154
trans_id = self._transform.trans_id_file_id(file_id)
2156
return self._final_paths._determine_path(trans_id)
2158
raise errors.NoSuchId(self, file_id)
2160
def _all_children(self, trans_id):
2161
children = self._all_children_cache.get(trans_id)
2162
if children is not None:
2164
children = set(self._transform.iter_tree_children(trans_id))
2165
# children in the _new_parent set are provided by _by_parent.
2166
children.difference_update(self._transform._new_parent)
2167
children.update(self._by_parent.get(trans_id, []))
2168
self._all_children_cache[trans_id] = children
2172
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2173
in self._transform._tree.extras())
2174
possible_extras.update(self._transform._new_contents)
2175
possible_extras.update(self._transform._removed_id)
2176
for trans_id in possible_extras:
2177
if self._transform.final_file_id(trans_id) is None:
2178
yield self._final_paths._determine_path(trans_id)
2180
def _make_inv_entries(self, ordered_entries, specific_files=None):
2181
for trans_id, parent_file_id in ordered_entries:
2182
file_id = self._transform.final_file_id(trans_id)
2185
if (specific_files is not None
2186
and self._final_paths.get_path(trans_id) not in specific_files):
2188
kind = self._transform.final_kind(trans_id)
2190
kind = self._transform._tree.stored_kind(
2191
self._transform._tree.id2path(file_id))
2192
new_entry = inventory.make_entry(
2194
self._transform.final_name(trans_id),
2195
parent_file_id, file_id)
2196
yield new_entry, trans_id
2198
def _list_files_by_dir(self):
2199
todo = [ROOT_PARENT]
2201
while len(todo) > 0:
2203
parent_file_id = self._transform.final_file_id(parent)
2204
children = list(self._all_children(parent))
2205
paths = dict(zip(children, self._final_paths.get_paths(children)))
2206
children.sort(key=paths.get)
2207
todo.extend(reversed(children))
2208
for trans_id in children:
2209
ordered_ids.append((trans_id, parent_file_id))
2212
def iter_child_entries(self, path):
2213
trans_id = self._path2trans_id(path)
2214
if trans_id is None:
2215
raise errors.NoSuchFile(path)
2216
todo = [(child_trans_id, trans_id) for child_trans_id in
2217
self._all_children(trans_id)]
2218
for entry, trans_id in self._make_inv_entries(todo):
2221
def iter_entries_by_dir(self, specific_files=None, recurse_nested=False):
2223
raise NotImplementedError(
2224
'follow tree references not yet supported')
2226
# This may not be a maximally efficient implementation, but it is
2227
# reasonably straightforward. An implementation that grafts the
2228
# TreeTransform changes onto the tree's iter_entries_by_dir results
2229
# might be more efficient, but requires tricky inferences about stack
2231
ordered_ids = self._list_files_by_dir()
2232
for entry, trans_id in self._make_inv_entries(ordered_ids,
2234
yield self._final_paths.get_path(trans_id), entry
2236
def _iter_entries_for_dir(self, dir_path):
2237
"""Return path, entry for items in a directory without recursing down."""
2239
dir_trans_id = self._path2trans_id(dir_path)
2240
dir_id = self._transform.final_file_id(dir_trans_id)
2241
for child_trans_id in self._all_children(dir_trans_id):
2242
ordered_ids.append((child_trans_id, dir_id))
2244
for entry, trans_id in self._make_inv_entries(ordered_ids):
2245
path_entries.append((self._final_paths.get_path(trans_id), entry))
2249
def list_files(self, include_root=False, from_dir=None, recursive=True,
2250
recurse_nested=False):
2251
"""See WorkingTree.list_files."""
2253
raise NotImplementedError(
2254
'follow tree references not yet supported')
2256
# XXX This should behave like WorkingTree.list_files, but is really
2257
# more like RevisionTree.list_files.
2263
prefix = from_dir + '/'
2264
entries = self.iter_entries_by_dir()
2265
for path, entry in entries:
2266
if entry.name == '' and not include_root:
2269
if not path.startswith(prefix):
2271
path = path[len(prefix):]
2272
yield path, 'V', entry.kind, entry
2274
if from_dir is None and include_root is True:
2275
root_entry = inventory.make_entry(
2276
'directory', '', ROOT_PARENT, self.path2id(''))
2277
yield '', 'V', 'directory', root_entry
2278
entries = self._iter_entries_for_dir(from_dir or '')
2279
for path, entry in entries:
2280
yield path, 'V', entry.kind, entry
2282
def kind(self, path):
2283
trans_id = self._path2trans_id(path)
2284
if trans_id is None:
2285
raise errors.NoSuchFile(path)
2286
return self._transform.final_kind(trans_id)
2288
def stored_kind(self, path):
2289
trans_id = self._path2trans_id(path)
2290
if trans_id is None:
2291
raise errors.NoSuchFile(path)
2293
return self._transform._new_contents[trans_id]
2295
return self._transform._tree.stored_kind(path)
2297
def get_file_mtime(self, path):
2298
"""See Tree.get_file_mtime"""
2299
file_id = self.path2id(path)
2301
raise errors.NoSuchFile(path)
2302
if not self._content_change(file_id):
2303
return self._transform._tree.get_file_mtime(
2304
self._transform._tree.id2path(file_id))
2305
trans_id = self._path2trans_id(path)
2306
return self._stat_limbo_file(trans_id).st_mtime
2308
def get_file_size(self, path):
2309
"""See Tree.get_file_size"""
2310
trans_id = self._path2trans_id(path)
2311
if trans_id is None:
2312
raise errors.NoSuchFile(path)
2313
kind = self._transform.final_kind(trans_id)
2316
if trans_id in self._transform._new_contents:
2317
return self._stat_limbo_file(trans_id).st_size
2318
if self.kind(path) == 'file':
2319
return self._transform._tree.get_file_size(path)
2323
def get_file_verifier(self, path, stat_value=None):
2324
trans_id = self._path2trans_id(path)
2325
if trans_id is None:
2326
raise errors.NoSuchFile(path)
2327
kind = self._transform._new_contents.get(trans_id)
2329
return self._transform._tree.get_file_verifier(path)
2331
with self.get_file(path) as fileobj:
2332
return ("SHA1", sha_file(fileobj))
2334
def get_file_sha1(self, path, stat_value=None):
2335
trans_id = self._path2trans_id(path)
2336
if trans_id is None:
2337
raise errors.NoSuchFile(path)
2338
kind = self._transform._new_contents.get(trans_id)
2340
return self._transform._tree.get_file_sha1(path)
2342
with self.get_file(path) as fileobj:
2343
return sha_file(fileobj)
2345
def get_reference_revision(self, path):
2346
trans_id = self._path2trans_id(path)
2347
if trans_id is None:
2348
raise errors.NoSuchFile(path)
2349
reference_revision = self._transform._new_reference_revision.get(trans_id)
2350
if reference_revision is None:
2351
return self._transform._tree.get_reference_revision(path)
2352
return reference_revision
2354
def is_executable(self, path):
2355
trans_id = self._path2trans_id(path)
2356
if trans_id is None:
2359
return self._transform._new_executability[trans_id]
2362
return self._transform._tree.is_executable(path)
2363
except OSError as e:
2364
if e.errno == errno.ENOENT:
2367
except errors.NoSuchFile:
2370
def has_filename(self, path):
2371
trans_id = self._path2trans_id(path)
2372
if trans_id in self._transform._new_contents:
2374
elif trans_id in self._transform._removed_contents:
2377
return self._transform._tree.has_filename(path)
2379
def path_content_summary(self, path):
2380
trans_id = self._path2trans_id(path)
2381
tt = self._transform
2382
tree_path = tt._tree_id_paths.get(trans_id)
2383
kind = tt._new_contents.get(trans_id)
2385
if tree_path is None or trans_id in tt._removed_contents:
2386
return 'missing', None, None, None
2387
summary = tt._tree.path_content_summary(tree_path)
2388
kind, size, executable, link_or_sha1 = summary
2391
limbo_name = tt._limbo_name(trans_id)
2392
if trans_id in tt._new_reference_revision:
2393
kind = 'tree-reference'
2395
statval = os.lstat(limbo_name)
2396
size = statval.st_size
2397
if not tt._limbo_supports_executable():
2400
executable = statval.st_mode & S_IEXEC
2404
if kind == 'symlink':
2405
link_or_sha1 = os.readlink(limbo_name)
2406
if not isinstance(link_or_sha1, str):
2407
link_or_sha1 = link_or_sha1.decode(osutils._fs_enc)
2408
executable = tt._new_executability.get(trans_id, executable)
2409
return kind, size, executable, link_or_sha1
2411
def iter_changes(self, from_tree, include_unchanged=False,
2412
specific_files=None, pb=None, extra_trees=None,
2413
require_versioned=True, want_unversioned=False):
2414
"""See InterTree.iter_changes.
2416
This has a fast path that is only used when the from_tree matches
2417
the transform tree, and no fancy options are supplied.
2419
if (from_tree is not self._transform._tree or include_unchanged
2420
or specific_files or want_unversioned):
2421
return tree.InterTree(from_tree, self).iter_changes(
2422
include_unchanged=include_unchanged,
2423
specific_files=specific_files,
2425
extra_trees=extra_trees,
2426
require_versioned=require_versioned,
2427
want_unversioned=want_unversioned)
2428
if want_unversioned:
2429
raise ValueError('want_unversioned is not supported')
2430
return self._transform.iter_changes()
2432
def get_file(self, path):
2433
"""See Tree.get_file"""
2434
file_id = self.path2id(path)
2435
if not self._content_change(file_id):
2436
return self._transform._tree.get_file(path)
2437
trans_id = self._path2trans_id(path)
2438
name = self._transform._limbo_name(trans_id)
2439
return open(name, 'rb')
2441
def get_file_with_stat(self, path):
2442
return self.get_file(path), None
2444
def annotate_iter(self, path,
2445
default_revision=_mod_revision.CURRENT_REVISION):
2446
file_id = self.path2id(path)
2447
changes = self._iter_changes_cache.get(file_id)
2451
changed_content, versioned, kind = (
2452
changes.changed_content, changes.versioned, changes.kind)
2455
get_old = (kind[0] == 'file' and versioned[0])
2457
old_annotation = self._transform._tree.annotate_iter(
2458
path, default_revision=default_revision)
2462
return old_annotation
2463
if not changed_content:
2464
return old_annotation
2465
# TODO: This is doing something similar to what WT.annotate_iter is
2466
# doing, however it fails slightly because it doesn't know what
2467
# the *other* revision_id is, so it doesn't know how to give the
2468
# other as the origin for some lines, they all get
2469
# 'default_revision'
2470
# It would be nice to be able to use the new Annotator based
2471
# approach, as well.
2472
return annotate.reannotate([old_annotation],
2473
self.get_file(path).readlines(),
2476
def get_symlink_target(self, path):
2477
"""See Tree.get_symlink_target"""
2478
file_id = self.path2id(path)
2479
if not self._content_change(file_id):
2480
return self._transform._tree.get_symlink_target(path)
2481
trans_id = self._path2trans_id(path)
2482
name = self._transform._limbo_name(trans_id)
2483
return osutils.readlink(name)
2485
def walkdirs(self, prefix=''):
2486
pending = [self._transform.root]
2487
while len(pending) > 0:
2488
parent_id = pending.pop()
2491
prefix = prefix.rstrip('/')
2492
parent_path = self._final_paths.get_path(parent_id)
2493
parent_file_id = self._transform.final_file_id(parent_id)
2494
for child_id in self._all_children(parent_id):
2495
path_from_root = self._final_paths.get_path(child_id)
2496
basename = self._transform.final_name(child_id)
2497
file_id = self._transform.final_file_id(child_id)
2498
kind = self._transform.final_kind(child_id)
2499
if kind is not None:
2500
versioned_kind = kind
2503
versioned_kind = self._transform._tree.stored_kind(
2504
self._transform._tree.id2path(file_id))
2505
if versioned_kind == 'directory':
2506
subdirs.append(child_id)
2507
children.append((path_from_root, basename, kind, None,
2508
file_id, versioned_kind))
2510
if parent_path.startswith(prefix):
2511
yield (parent_path, parent_file_id), children
2512
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2515
def get_parent_ids(self):
2516
return self._parent_ids
2518
def set_parent_ids(self, parent_ids):
2519
self._parent_ids = parent_ids
2521
def get_revision_tree(self, revision_id):
2522
return self._transform._tree.get_revision_tree(revision_id)
2525
def joinpath(parent, child):
2526
"""Join tree-relative paths, handling the tree root specially"""
2527
if parent is None or parent == "":
2530
return pathjoin(parent, child)
2533
class FinalPaths(object):
2534
"""Make path calculation cheap by memoizing paths.
2536
The underlying tree must not be manipulated between calls, or else
2537
the results will likely be incorrect.
2540
def __init__(self, transform):
2541
object.__init__(self)
2542
self._known_paths = {}
2543
self.transform = transform
2545
def _determine_path(self, trans_id):
2546
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2548
name = self.transform.final_name(trans_id)
2549
parent_id = self.transform.final_parent(trans_id)
2550
if parent_id == self.transform.root:
2553
return pathjoin(self.get_path(parent_id), name)
2555
def get_path(self, trans_id):
2556
"""Find the final path associated with a trans_id"""
2557
if trans_id not in self._known_paths:
2558
self._known_paths[trans_id] = self._determine_path(trans_id)
2559
return self._known_paths[trans_id]
2561
def get_paths(self, trans_ids):
2562
return [(self.get_path(t), t) for t in trans_ids]
2565
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2566
delta_from_tree=False):
2567
"""Create working tree for a branch, using a TreeTransform.
2569
This function should be used on empty trees, having a tree root at most.
2570
(see merge and revert functionality for working with existing trees)
2572
Existing files are handled like so:
2574
- Existing bzrdirs take precedence over creating new items. They are
2575
created as '%s.diverted' % name.
2576
- Otherwise, if the content on disk matches the content we are building,
2577
it is silently replaced.
2578
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2580
:param tree: The tree to convert wt into a copy of
2581
:param wt: The working tree that files will be placed into
2582
:param accelerator_tree: A tree which can be used for retrieving file
2583
contents more quickly than tree itself, i.e. a workingtree. tree
2584
will be used for cases where accelerator_tree's content is different.
2585
:param hardlink: If true, hard-link files to accelerator_tree, where
2586
possible. accelerator_tree must implement abspath, i.e. be a
2588
:param delta_from_tree: If true, build_tree may use the input Tree to
2589
generate the inventory delta.
2591
with contextlib.ExitStack() as exit_stack:
2592
exit_stack.enter_context(wt.lock_tree_write())
2593
exit_stack.enter_context(tree.lock_read())
2594
if accelerator_tree is not None:
2595
exit_stack.enter_context(accelerator_tree.lock_read())
2596
return _build_tree(tree, wt, accelerator_tree, hardlink,
2600
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2601
"""See build_tree."""
2602
for num, _unused in enumerate(wt.all_versioned_paths()):
2603
if num > 0: # more than just a root
2604
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2606
top_pb = ui.ui_factory.nested_progress_bar()
2607
pp = ProgressPhase("Build phase", 2, top_pb)
2608
if tree.path2id('') is not None:
2609
# This is kind of a hack: we should be altering the root
2610
# as part of the regular tree shape diff logic.
2611
# The conditional test here is to avoid doing an
2612
# expensive operation (flush) every time the root id
2613
# is set within the tree, nor setting the root and thus
2614
# marking the tree as dirty, because we use two different
2615
# idioms here: tree interfaces and inventory interfaces.
2616
if wt.path2id('') != tree.path2id(''):
2617
wt.set_root_id(tree.path2id(''))
2619
tt = wt.get_transform()
2623
file_trans_id[wt.path2id('')] = tt.trans_id_tree_path('')
2624
with ui.ui_factory.nested_progress_bar() as pb:
2625
deferred_contents = []
2627
total = len(tree.all_versioned_paths())
2629
precomputed_delta = []
2631
precomputed_delta = None
2632
# Check if tree inventory has content. If so, we populate
2633
# existing_files with the directory content. If there are no
2634
# entries we skip populating existing_files as its not used.
2635
# This improves performance and unncessary work on large
2636
# directory trees. (#501307)
2638
existing_files = set()
2639
for dir, files in wt.walkdirs():
2640
existing_files.update(f[0] for f in files)
2641
for num, (tree_path, entry) in \
2642
enumerate(tree.iter_entries_by_dir()):
2643
pb.update(gettext("Building tree"), num
2644
- len(deferred_contents), total)
2645
if entry.parent_id is None:
2648
file_id = entry.file_id
2650
precomputed_delta.append((None, tree_path, file_id, entry))
2651
if tree_path in existing_files:
2652
target_path = wt.abspath(tree_path)
2653
kind = file_kind(target_path)
2654
if kind == "directory":
2656
controldir.ControlDir.open(target_path)
2657
except errors.NotBranchError:
2661
if (file_id not in divert
2663
tree, entry, tree_path, kind, target_path)):
2664
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2665
if kind == 'directory':
2667
parent_id = file_trans_id[entry.parent_id]
2668
if entry.kind == 'file':
2669
# We *almost* replicate new_by_entry, so that we can defer
2670
# getting the file text, and get them all at once.
2671
trans_id = tt.create_path(entry.name, parent_id)
2672
file_trans_id[file_id] = trans_id
2673
tt.version_file(file_id, trans_id)
2674
executable = tree.is_executable(tree_path)
2676
tt.set_executability(executable, trans_id)
2677
trans_data = (trans_id, file_id,
2678
tree_path, entry.text_sha1)
2679
deferred_contents.append((tree_path, trans_data))
2681
file_trans_id[file_id] = new_by_entry(
2682
tree_path, tt, entry, parent_id, tree)
2684
new_trans_id = file_trans_id[file_id]
2685
old_parent = tt.trans_id_tree_path(tree_path)
2686
_reparent_children(tt, old_parent, new_trans_id)
2687
offset = num + 1 - len(deferred_contents)
2688
_create_files(tt, tree, deferred_contents, pb, offset,
2689
accelerator_tree, hardlink)
2691
divert_trans = set(file_trans_id[f] for f in divert)
2694
return resolve_checkout(t, c, divert_trans)
2695
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2696
if len(raw_conflicts) > 0:
2697
precomputed_delta = None
2698
conflicts = cook_conflicts(raw_conflicts, tt)
2699
for conflict in conflicts:
2700
trace.warning(str(conflict))
2702
wt.add_conflicts(conflicts)
2703
except errors.UnsupportedOperation:
2705
result = tt.apply(no_conflicts=True,
2706
precomputed_delta=precomputed_delta)
2713
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2715
total = len(desired_files) + offset
2717
if accelerator_tree is None:
2718
new_desired_files = desired_files
2720
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2722
change.path for change in iter
2723
if not (change.changed_content or change.executable[0] != change.executable[1])]
2724
if accelerator_tree.supports_content_filtering():
2725
unchanged = [(tp, ap) for (tp, ap) in unchanged
2726
if not next(accelerator_tree.iter_search_rules([ap]))]
2727
unchanged = dict(unchanged)
2728
new_desired_files = []
2730
for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
2731
accelerator_path = unchanged.get(tree_path)
2732
if accelerator_path is None:
2733
new_desired_files.append((tree_path,
2734
(trans_id, file_id, tree_path, text_sha1)))
2736
pb.update(gettext('Adding file contents'), count + offset, total)
2738
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2741
with accelerator_tree.get_file(accelerator_path) as f:
2742
chunks = osutils.file_iterator(f)
2743
if wt.supports_content_filtering():
2744
filters = wt._content_filter_stack(tree_path)
2745
chunks = filtered_output_bytes(chunks, filters,
2746
ContentFilterContext(tree_path, tree))
2747
tt.create_file(chunks, trans_id, sha1=text_sha1)
2750
for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
2751
tree.iter_files_bytes(new_desired_files)):
2752
if wt.supports_content_filtering():
2753
filters = wt._content_filter_stack(tree_path)
2754
contents = filtered_output_bytes(contents, filters,
2755
ContentFilterContext(tree_path, tree))
2756
tt.create_file(contents, trans_id, sha1=text_sha1)
2757
pb.update(gettext('Adding file contents'), count + offset, total)
2760
def _reparent_children(tt, old_parent, new_parent):
2761
for child in tt.iter_tree_children(old_parent):
2762
tt.adjust_path(tt.final_name(child), new_parent, child)
2765
def _reparent_transform_children(tt, old_parent, new_parent):
2766
by_parent = tt.by_parent()
2767
for child in by_parent[old_parent]:
2768
tt.adjust_path(tt.final_name(child), new_parent, child)
2769
return by_parent[old_parent]
2772
def _content_match(tree, entry, tree_path, kind, target_path):
2773
if entry.kind != kind:
2775
if entry.kind == "directory":
2777
if entry.kind == "file":
2778
with open(target_path, 'rb') as f1, \
2779
tree.get_file(tree_path) as f2:
2780
if osutils.compare_files(f1, f2):
2782
elif entry.kind == "symlink":
2783
if tree.get_symlink_target(tree_path) == os.readlink(target_path):
2788
def resolve_checkout(tt, conflicts, divert):
2789
new_conflicts = set()
2790
for c_type, conflict in ((c[0], c) for c in conflicts):
2791
# Anything but a 'duplicate' would indicate programmer error
2792
if c_type != 'duplicate':
2793
raise AssertionError(c_type)
2794
# Now figure out which is new and which is old
2795
if tt.new_contents(conflict[1]):
2796
new_file = conflict[1]
2797
old_file = conflict[2]
2799
new_file = conflict[2]
2800
old_file = conflict[1]
2802
# We should only get here if the conflict wasn't completely
2804
final_parent = tt.final_parent(old_file)
2805
if new_file in divert:
2806
new_name = tt.final_name(old_file) + '.diverted'
2807
tt.adjust_path(new_name, final_parent, new_file)
2808
new_conflicts.add((c_type, 'Diverted to',
2809
new_file, old_file))
2811
new_name = tt.final_name(old_file) + '.moved'
2812
tt.adjust_path(new_name, final_parent, old_file)
2813
new_conflicts.add((c_type, 'Moved existing file to',
2814
old_file, new_file))
2815
return new_conflicts
2818
def new_by_entry(path, tt, entry, parent_id, tree):
2819
"""Create a new file according to its inventory entry"""
2823
with tree.get_file(path) as f:
2824
executable = tree.is_executable(path)
2826
name, parent_id, osutils.file_iterator(f), entry.file_id,
2828
elif kind in ('directory', 'tree-reference'):
2829
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2830
if kind == 'tree-reference':
2831
tt.set_tree_reference(entry.reference_revision, trans_id)
2833
elif kind == 'symlink':
2834
target = tree.get_symlink_target(path)
2835
return tt.new_symlink(name, parent_id, target, entry.file_id)
2837
raise errors.BadFileKindError(name, kind)
2840
def create_from_tree(tt, trans_id, tree, path, chunks=None,
2841
filter_tree_path=None):
2842
"""Create new file contents according to tree contents.
2844
:param filter_tree_path: the tree path to use to lookup
2845
content filters to apply to the bytes output in the working tree.
2846
This only applies if the working tree supports content filtering.
2848
kind = tree.kind(path)
2849
if kind == 'directory':
2850
tt.create_directory(trans_id)
2851
elif kind == "file":
2853
f = tree.get_file(path)
2854
chunks = osutils.file_iterator(f)
2859
if wt.supports_content_filtering() and filter_tree_path is not None:
2860
filters = wt._content_filter_stack(filter_tree_path)
2861
chunks = filtered_output_bytes(
2863
ContentFilterContext(filter_tree_path, tree))
2864
tt.create_file(chunks, trans_id)
2868
elif kind == "symlink":
2869
tt.create_symlink(tree.get_symlink_target(path), trans_id)
2871
raise AssertionError('Unknown kind %r' % kind)
2874
def create_entry_executability(tt, entry, trans_id):
2875
"""Set the executability of a trans_id according to an inventory entry"""
2876
if entry.kind == "file":
2877
tt.set_executability(entry.executable, trans_id)
2880
def revert(working_tree, target_tree, filenames, backups=False,
2881
pb=None, change_reporter=None):
2882
"""Revert a working tree's contents to those of a target tree."""
2883
pb = ui.ui_factory.nested_progress_bar()
2885
with target_tree.lock_read(), working_tree.get_transform(pb) as tt:
2886
pp = ProgressPhase("Revert phase", 3, pb)
2887
conflicts, merge_modified = _prepare_revert_transform(
2888
working_tree, target_tree, tt, filenames, backups, pp)
2890
change_reporter = delta._ChangeReporter(
2891
unversioned_filter=working_tree.is_ignored)
2892
delta.report_changes(tt.iter_changes(), change_reporter)
2893
for conflict in conflicts:
2894
trace.warning(str(conflict))
2897
if working_tree.supports_merge_modified():
2898
working_tree.set_merge_modified(merge_modified)
2904
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2905
backups, pp, basis_tree=None,
2906
merge_modified=None):
2907
with ui.ui_factory.nested_progress_bar() as child_pb:
2908
if merge_modified is None:
2909
merge_modified = working_tree.merge_modified()
2910
merge_modified = _alter_files(working_tree, target_tree, tt,
2911
child_pb, filenames, backups,
2912
merge_modified, basis_tree)
2913
with ui.ui_factory.nested_progress_bar() as child_pb:
2914
raw_conflicts = resolve_conflicts(
2915
tt, child_pb, lambda t, c: conflict_pass(t, c, target_tree))
2916
conflicts = cook_conflicts(raw_conflicts, tt)
2917
return conflicts, merge_modified
2920
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2921
backups, merge_modified, basis_tree=None):
2922
if basis_tree is not None:
2923
basis_tree.lock_read()
2924
# We ask the working_tree for its changes relative to the target, rather
2925
# than the target changes relative to the working tree. Because WT4 has an
2926
# optimizer to compare itself to a target, but no optimizer for the
2928
change_list = working_tree.iter_changes(
2929
target_tree, specific_files=specific_files, pb=pb)
2930
if not target_tree.is_versioned(u''):
2936
for id_num, change in enumerate(change_list):
2937
file_id = change.file_id
2938
target_path, wt_path = change.path
2939
target_versioned, wt_versioned = change.versioned
2940
target_parent, wt_parent = change.parent_id
2941
target_name, wt_name = change.name
2942
target_kind, wt_kind = change.kind
2943
target_executable, wt_executable = change.executable
2944
if skip_root and wt_parent is None:
2946
trans_id = tt.trans_id_file_id(file_id)
2948
if change.changed_content:
2949
keep_content = False
2950
if wt_kind == 'file' and (backups or target_kind is None):
2951
wt_sha1 = working_tree.get_file_sha1(wt_path)
2952
if merge_modified.get(wt_path) != wt_sha1:
2953
# acquire the basis tree lazily to prevent the
2954
# expense of accessing it when it's not needed ?
2955
# (Guessing, RBC, 200702)
2956
if basis_tree is None:
2957
basis_tree = working_tree.basis_tree()
2958
basis_tree.lock_read()
2959
basis_path = find_previous_path(
2960
working_tree, basis_tree, wt_path)
2961
if basis_path is None:
2962
if target_kind is None and not target_versioned:
2965
if wt_sha1 != basis_tree.get_file_sha1(basis_path):
2967
if wt_kind is not None:
2968
if not keep_content:
2969
tt.delete_contents(trans_id)
2970
elif target_kind is not None:
2971
parent_trans_id = tt.trans_id_file_id(wt_parent)
2972
backup_name = tt._available_backup_name(
2973
wt_name, parent_trans_id)
2974
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2975
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2976
if wt_versioned and target_versioned:
2977
tt.unversion_file(trans_id)
2978
tt.version_file(file_id, new_trans_id)
2979
# New contents should have the same unix perms as old
2982
trans_id = new_trans_id
2983
if target_kind in ('directory', 'tree-reference'):
2984
tt.create_directory(trans_id)
2985
if target_kind == 'tree-reference':
2986
revision = target_tree.get_reference_revision(
2988
tt.set_tree_reference(revision, trans_id)
2989
elif target_kind == 'symlink':
2990
tt.create_symlink(target_tree.get_symlink_target(
2991
target_path), trans_id)
2992
elif target_kind == 'file':
2993
deferred_files.append(
2994
(target_path, (trans_id, mode_id, file_id)))
2995
if basis_tree is None:
2996
basis_tree = working_tree.basis_tree()
2997
basis_tree.lock_read()
2998
new_sha1 = target_tree.get_file_sha1(target_path)
2999
basis_path = find_previous_path(target_tree, basis_tree, target_path)
3000
if (basis_path is not None and
3001
new_sha1 == basis_tree.get_file_sha1(basis_path)):
3002
# If the new contents of the file match what is in basis,
3003
# then there is no need to store in merge_modified.
3004
if basis_path in merge_modified:
3005
del merge_modified[basis_path]
3007
merge_modified[target_path] = new_sha1
3009
# preserve the execute bit when backing up
3010
if keep_content and wt_executable == target_executable:
3011
tt.set_executability(target_executable, trans_id)
3012
elif target_kind is not None:
3013
raise AssertionError(target_kind)
3014
if not wt_versioned and target_versioned:
3015
tt.version_file(file_id, trans_id)
3016
if wt_versioned and not target_versioned:
3017
tt.unversion_file(trans_id)
3018
if (target_name is not None
3019
and (wt_name != target_name or wt_parent != target_parent)):
3020
if target_name == '' and target_parent is None:
3021
parent_trans = ROOT_PARENT
3023
parent_trans = tt.trans_id_file_id(target_parent)
3024
if wt_parent is None and wt_versioned:
3025
tt.adjust_root_path(target_name, parent_trans)
3027
tt.adjust_path(target_name, parent_trans, trans_id)
3028
if wt_executable != target_executable and target_kind == "file":
3029
tt.set_executability(target_executable, trans_id)
3030
if working_tree.supports_content_filtering():
3031
for (trans_id, mode_id, file_id), bytes in (
3032
target_tree.iter_files_bytes(deferred_files)):
3033
# We're reverting a tree to the target tree so using the
3034
# target tree to find the file path seems the best choice
3035
# here IMO - Ian C 27/Oct/2009
3036
filter_tree_path = target_tree.id2path(file_id)
3037
filters = working_tree._content_filter_stack(filter_tree_path)
3038
bytes = filtered_output_bytes(
3040
ContentFilterContext(filter_tree_path, working_tree))
3041
tt.create_file(bytes, trans_id, mode_id)
3043
for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
3045
tt.create_file(bytes, trans_id, mode_id)
3046
tt.fixup_new_roots()
3048
if basis_tree is not None:
3050
return merge_modified
3053
def resolve_conflicts(tt, pb=None, pass_func=None):
3054
"""Make many conflict-resolution attempts, but die if they fail"""
3055
if pass_func is None:
3056
pass_func = conflict_pass
3057
new_conflicts = set()
3058
with ui.ui_factory.nested_progress_bar() as pb:
3060
pb.update(gettext('Resolution pass'), n + 1, 10)
3061
conflicts = tt.find_conflicts()
3062
if len(conflicts) == 0:
3063
return new_conflicts
3064
new_conflicts.update(pass_func(tt, conflicts))
3065
raise MalformedTransform(conflicts=conflicts)
3068
def conflict_pass(tt, conflicts, path_tree=None):
3069
"""Resolve some classes of conflicts.
3071
:param tt: The transform to resolve conflicts in
3072
:param conflicts: The conflicts to resolve
3073
:param path_tree: A Tree to get supplemental paths from
3075
new_conflicts = set()
3076
for c_type, conflict in ((c[0], c) for c in conflicts):
3077
if c_type == 'duplicate id':
3078
tt.unversion_file(conflict[1])
3079
new_conflicts.add((c_type, 'Unversioned existing file',
3080
conflict[1], conflict[2], ))
3081
elif c_type == 'duplicate':
3082
# files that were renamed take precedence
3083
final_parent = tt.final_parent(conflict[1])
3084
if tt.path_changed(conflict[1]):
3085
existing_file, new_file = conflict[2], conflict[1]
3087
existing_file, new_file = conflict[1], conflict[2]
3088
new_name = tt.final_name(existing_file) + '.moved'
3089
tt.adjust_path(new_name, final_parent, existing_file)
3090
new_conflicts.add((c_type, 'Moved existing file to',
3091
existing_file, new_file))
3092
elif c_type == 'parent loop':
3093
# break the loop by undoing one of the ops that caused the loop
3095
while not tt.path_changed(cur):
3096
cur = tt.final_parent(cur)
3097
new_conflicts.add((c_type, 'Cancelled move', cur,
3098
tt.final_parent(cur),))
3099
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3101
elif c_type == 'missing parent':
3102
trans_id = conflict[1]
3103
if trans_id in tt._removed_contents:
3104
cancel_deletion = True
3105
orphans = tt._get_potential_orphans(trans_id)
3107
cancel_deletion = False
3108
# All children are orphans
3111
tt.new_orphan(o, trans_id)
3112
except OrphaningError:
3113
# Something bad happened so we cancel the directory
3114
# deletion which will leave it in place with a
3115
# conflict. The user can deal with it from there.
3116
# Note that this also catch the case where we don't
3117
# want to create orphans and leave the directory in
3119
cancel_deletion = True
3122
# Cancel the directory deletion
3123
tt.cancel_deletion(trans_id)
3124
new_conflicts.add(('deleting parent', 'Not deleting',
3129
tt.final_name(trans_id)
3131
if path_tree is not None:
3132
file_id = tt.final_file_id(trans_id)
3134
file_id = tt.inactive_file_id(trans_id)
3135
_, entry = next(path_tree.iter_entries_by_dir(
3136
specific_files=[path_tree.id2path(file_id)]))
3137
# special-case the other tree root (move its
3138
# children to current root)
3139
if entry.parent_id is None:
3141
moved = _reparent_transform_children(
3142
tt, trans_id, tt.root)
3144
new_conflicts.add((c_type, 'Moved to root',
3147
parent_trans_id = tt.trans_id_file_id(
3149
tt.adjust_path(entry.name, parent_trans_id,
3152
tt.create_directory(trans_id)
3153
new_conflicts.add((c_type, 'Created directory', trans_id))
3154
elif c_type == 'unversioned parent':
3155
file_id = tt.inactive_file_id(conflict[1])
3156
# special-case the other tree root (move its children instead)
3157
if path_tree and path_tree.path2id('') == file_id:
3158
# This is the root entry, skip it
3160
tt.version_file(file_id, conflict[1])
3161
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3162
elif c_type == 'non-directory parent':
3163
parent_id = conflict[1]
3164
parent_parent = tt.final_parent(parent_id)
3165
parent_name = tt.final_name(parent_id)
3166
parent_file_id = tt.final_file_id(parent_id)
3167
new_parent_id = tt.new_directory(parent_name + '.new',
3168
parent_parent, parent_file_id)
3169
_reparent_transform_children(tt, parent_id, new_parent_id)
3170
if parent_file_id is not None:
3171
tt.unversion_file(parent_id)
3172
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3173
elif c_type == 'versioning no contents':
3174
tt.cancel_versioning(conflict[1])
3175
return new_conflicts
3178
def cook_conflicts(raw_conflicts, tt):
3179
"""Generate a list of cooked conflicts, sorted by file path"""
3180
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3181
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3184
def iter_cook_conflicts(raw_conflicts, tt):
3186
for conflict in raw_conflicts:
3187
c_type = conflict[0]
3188
action = conflict[1]
3189
modified_path = fp.get_path(conflict[2])
3190
modified_id = tt.final_file_id(conflict[2])
3191
if len(conflict) == 3:
3192
yield conflicts.Conflict.factory(
3193
c_type, action=action, path=modified_path, file_id=modified_id)
3196
conflicting_path = fp.get_path(conflict[3])
3197
conflicting_id = tt.final_file_id(conflict[3])
3198
yield conflicts.Conflict.factory(
3199
c_type, action=action, path=modified_path,
3200
file_id=modified_id,
3201
conflict_path=conflicting_path,
3202
conflict_file_id=conflicting_id)
3205
class _FileMover(object):
3206
"""Moves and deletes files for TreeTransform, tracking operations"""
3209
self.past_renames = []
3210
self.pending_deletions = []
3212
def rename(self, from_, to):
3213
"""Rename a file from one path to another."""
3215
os.rename(from_, to)
3216
except OSError as e:
3217
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3218
raise errors.FileExists(to, str(e))
3219
# normal OSError doesn't include filenames so it's hard to see where
3220
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3221
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3222
self.past_renames.append((from_, to))
3224
def pre_delete(self, from_, to):
3225
"""Rename a file out of the way and mark it for deletion.
3227
Unlike os.unlink, this works equally well for files and directories.
3228
:param from_: The current file path
3229
:param to: A temporary path for the file
3231
self.rename(from_, to)
3232
self.pending_deletions.append(to)
3235
"""Reverse all renames that have been performed"""
3236
for from_, to in reversed(self.past_renames):
3238
os.rename(to, from_)
3239
except OSError as e:
3240
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3241
# after rollback, don't reuse _FileMover
3242
self.past_renames = None
3243
self.pending_deletions = None
3245
def apply_deletions(self):
3246
"""Apply all marked deletions"""
3247
for path in self.pending_deletions:
3249
# after apply_deletions, don't reuse _FileMover
3250
self.past_renames = None
3251
self.pending_deletions = None
3254
def link_tree(target_tree, source_tree):
3255
"""Where possible, hard-link files in a tree to those in another tree.
3257
:param target_tree: Tree to change
3258
:param source_tree: Tree to hard-link from
3260
with target_tree.get_transform() as tt:
3261
for change in target_tree.iter_changes(source_tree, include_unchanged=True):
3262
if change.changed_content:
3264
if change.kind != ('file', 'file'):
3266
if change.executable[0] != change.executable[1]:
3268
trans_id = tt.trans_id_tree_path(change.path[1])
3269
tt.delete_contents(trans_id)
3270
tt.create_hardlink(source_tree.abspath(change.path[0]), trans_id)
added
removed
breezy/transform.py
