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
20
from stat import S_ISREG, S_IEXEC
24
config as _mod_config,
31
lazy_import.lazy_import(globals(), """
42
revision as _mod_revision,
46
from breezy.bzr import (
50
from breezy.i18n import gettext
52
from .errors import (DuplicateKey, MalformedTransform,
53
ReusingTransform, CantMoveRoot,
54
ImmortalLimbo, NoFinalPath)
55
from .filters import filtered_output_bytes, ContentFilterContext
56
from .mutabletree import MutableTree
57
from .osutils import (
65
from .progress import ProgressPhase
72
ROOT_PARENT = "root-parent"
75
def unique_add(map, key, value):
77
raise DuplicateKey(key=key)
81
class _TransformResults(object):
82
def __init__(self, modified_paths, rename_count):
84
self.modified_paths = modified_paths
85
self.rename_count = rename_count
88
class TreeTransformBase(object):
89
"""The base class for TreeTransform and its kin."""
91
def __init__(self, tree, pb=None, case_sensitive=True):
94
:param tree: The tree that will be transformed, but not necessarily
97
:param case_sensitive: If True, the target of the transform is
98
case sensitive, not just case preserving.
100
object.__init__(self)
103
# mapping of trans_id -> new basename
105
# mapping of trans_id -> new parent trans_id
106
self._new_parent = {}
107
# mapping of trans_id with new contents -> new file_kind
108
self._new_contents = {}
109
# mapping of trans_id => (sha1 of content, stat_value)
110
self._observed_sha1s = {}
111
# Set of trans_ids whose contents will be removed
112
self._removed_contents = set()
113
# Mapping of trans_id -> new execute-bit value
114
self._new_executability = {}
115
# Mapping of trans_id -> new tree-reference value
116
self._new_reference_revision = {}
117
# Mapping of trans_id -> new file_id
119
# Mapping of old file-id -> trans_id
120
self._non_present_ids = {}
121
# Mapping of new file_id -> trans_id
123
# Set of trans_ids that will be removed
124
self._removed_id = set()
125
# Mapping of path in old tree -> trans_id
126
self._tree_path_ids = {}
127
# Mapping trans_id -> path in old tree
128
self._tree_id_paths = {}
129
# The trans_id that will be used as the tree root
130
if tree.is_versioned(''):
131
self._new_root = self.trans_id_tree_path('')
133
self._new_root = None
134
# Indicator of whether the transform has been applied
138
# Whether the target is case sensitive
139
self._case_sensitive_target = case_sensitive
140
# A counter of how many files have been renamed
141
self.rename_count = 0
144
"""Support Context Manager API."""
147
def __exit__(self, exc_type, exc_val, exc_tb):
148
"""Support Context Manager API."""
152
"""Release the working tree lock, if held.
154
This is required if apply has not been invoked, but can be invoked
157
if self._tree is None:
159
for hook in MutableTree.hooks['post_transform']:
160
hook(self._tree, self)
164
def __get_root(self):
165
return self._new_root
167
root = property(__get_root)
169
def _assign_id(self):
170
"""Produce a new tranform id"""
171
new_id = "new-%s" % self._id_number
175
def create_path(self, name, parent):
176
"""Assign a transaction id to a new path"""
177
trans_id = self._assign_id()
178
unique_add(self._new_name, trans_id, name)
179
unique_add(self._new_parent, trans_id, parent)
182
def adjust_path(self, name, parent, trans_id):
183
"""Change the path that is assigned to a transaction id."""
185
raise ValueError("Parent trans-id may not be None")
186
if trans_id == self._new_root:
188
self._new_name[trans_id] = name
189
self._new_parent[trans_id] = parent
191
def adjust_root_path(self, name, parent):
192
"""Emulate moving the root by moving all children, instead.
194
We do this by undoing the association of root's transaction id with the
195
current tree. This allows us to create a new directory with that
196
transaction id. We unversion the root directory and version the
197
physically new directory, and hope someone versions the tree root
200
old_root = self._new_root
201
old_root_file_id = self.final_file_id(old_root)
202
# force moving all children of root
203
for child_id in self.iter_tree_children(old_root):
204
if child_id != parent:
205
self.adjust_path(self.final_name(child_id),
206
self.final_parent(child_id), child_id)
207
file_id = self.final_file_id(child_id)
208
if file_id is not None:
209
self.unversion_file(child_id)
210
self.version_file(file_id, child_id)
212
# the physical root needs a new transaction id
213
self._tree_path_ids.pop("")
214
self._tree_id_paths.pop(old_root)
215
self._new_root = self.trans_id_tree_path('')
216
if parent == old_root:
217
parent = self._new_root
218
self.adjust_path(name, parent, old_root)
219
self.create_directory(old_root)
220
self.version_file(old_root_file_id, old_root)
221
self.unversion_file(self._new_root)
223
def fixup_new_roots(self):
224
"""Reinterpret requests to change the root directory
226
Instead of creating a root directory, or moving an existing directory,
227
all the attributes and children of the new root are applied to the
228
existing root directory.
230
This means that the old root trans-id becomes obsolete, so it is
231
recommended only to invoke this after the root trans-id has become
235
new_roots = [k for k, v in self._new_parent.items()
237
if len(new_roots) < 1:
239
if len(new_roots) != 1:
240
raise ValueError('A tree cannot have two roots!')
241
if self._new_root is None:
242
self._new_root = new_roots[0]
244
old_new_root = new_roots[0]
245
# unversion the new root's directory.
246
if self.final_kind(self._new_root) is None:
247
file_id = self.final_file_id(old_new_root)
249
file_id = self.final_file_id(self._new_root)
250
if old_new_root in self._new_id:
251
self.cancel_versioning(old_new_root)
253
self.unversion_file(old_new_root)
254
# if, at this stage, root still has an old file_id, zap it so we can
255
# stick a new one in.
256
if (self.tree_file_id(self._new_root) is not None
257
and self._new_root not in self._removed_id):
258
self.unversion_file(self._new_root)
259
if file_id is not None:
260
self.version_file(file_id, self._new_root)
262
# Now move children of new root into old root directory.
263
# Ensure all children are registered with the transaction, but don't
264
# use directly-- some tree children have new parents
265
list(self.iter_tree_children(old_new_root))
266
# Move all children of new root into old root directory.
267
for child in self.by_parent().get(old_new_root, []):
268
self.adjust_path(self.final_name(child), self._new_root, child)
270
# Ensure old_new_root has no directory.
271
if old_new_root in self._new_contents:
272
self.cancel_creation(old_new_root)
274
self.delete_contents(old_new_root)
276
# prevent deletion of root directory.
277
if self._new_root in self._removed_contents:
278
self.cancel_deletion(self._new_root)
280
# destroy path info for old_new_root.
281
del self._new_parent[old_new_root]
282
del self._new_name[old_new_root]
284
def trans_id_file_id(self, file_id):
285
"""Determine or set the transaction id associated with a file ID.
286
A new id is only created for file_ids that were never present. If
287
a transaction has been unversioned, it is deliberately still returned.
288
(this will likely lead to an unversioned parent conflict.)
291
raise ValueError('None is not a valid file id')
292
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
293
return self._r_new_id[file_id]
296
path = self._tree.id2path(file_id)
297
except errors.NoSuchId:
298
if file_id in self._non_present_ids:
299
return self._non_present_ids[file_id]
301
trans_id = self._assign_id()
302
self._non_present_ids[file_id] = trans_id
305
return self.trans_id_tree_path(path)
307
def trans_id_tree_path(self, path):
308
"""Determine (and maybe set) the transaction ID for a tree path."""
309
path = self.canonical_path(path)
310
if path not in self._tree_path_ids:
311
self._tree_path_ids[path] = self._assign_id()
312
self._tree_id_paths[self._tree_path_ids[path]] = path
313
return self._tree_path_ids[path]
315
def get_tree_parent(self, trans_id):
316
"""Determine id of the parent in the tree."""
317
path = self._tree_id_paths[trans_id]
320
return self.trans_id_tree_path(os.path.dirname(path))
322
def delete_contents(self, trans_id):
323
"""Schedule the contents of a path entry for deletion"""
324
kind = self.tree_kind(trans_id)
326
self._removed_contents.add(trans_id)
328
def cancel_deletion(self, trans_id):
329
"""Cancel a scheduled deletion"""
330
self._removed_contents.remove(trans_id)
332
def unversion_file(self, trans_id):
333
"""Schedule a path entry to become unversioned"""
334
self._removed_id.add(trans_id)
336
def delete_versioned(self, trans_id):
337
"""Delete and unversion a versioned file"""
338
self.delete_contents(trans_id)
339
self.unversion_file(trans_id)
341
def set_executability(self, executability, trans_id):
342
"""Schedule setting of the 'execute' bit
343
To unschedule, set to None
345
if executability is None:
346
del self._new_executability[trans_id]
348
unique_add(self._new_executability, trans_id, executability)
350
def set_tree_reference(self, revision_id, trans_id):
351
"""Set the reference associated with a directory"""
352
unique_add(self._new_reference_revision, trans_id, revision_id)
354
def version_file(self, file_id, trans_id):
355
"""Schedule a file to become versioned."""
358
unique_add(self._new_id, trans_id, file_id)
359
unique_add(self._r_new_id, file_id, trans_id)
361
def cancel_versioning(self, trans_id):
362
"""Undo a previous versioning of a file"""
363
file_id = self._new_id[trans_id]
364
del self._new_id[trans_id]
365
del self._r_new_id[file_id]
367
def new_paths(self, filesystem_only=False):
368
"""Determine the paths of all new and changed files.
370
:param filesystem_only: if True, only calculate values for files
371
that require renames or execute bit changes.
375
stale_ids = self._needs_rename.difference(self._new_name)
376
stale_ids.difference_update(self._new_parent)
377
stale_ids.difference_update(self._new_contents)
378
stale_ids.difference_update(self._new_id)
379
needs_rename = self._needs_rename.difference(stale_ids)
380
id_sets = (needs_rename, self._new_executability)
382
id_sets = (self._new_name, self._new_parent, self._new_contents,
383
self._new_id, self._new_executability)
384
for id_set in id_sets:
385
new_ids.update(id_set)
386
return sorted(FinalPaths(self).get_paths(new_ids))
388
def _inventory_altered(self):
389
"""Determine which trans_ids need new Inventory entries.
391
An new entry is needed when anything that would be reflected by an
392
inventory entry changes, including file name, file_id, parent file_id,
393
file kind, and the execute bit.
395
Some care is taken to return entries with real changes, not cases
396
where the value is deleted and then restored to its original value,
397
but some actually unchanged values may be returned.
399
:returns: A list of (path, trans_id) for all items requiring an
400
inventory change. Ordered by path.
403
# Find entries whose file_ids are new (or changed).
404
new_file_id = set(t for t in self._new_id
405
if self._new_id[t] != self.tree_file_id(t))
406
for id_set in [self._new_name, self._new_parent, new_file_id,
407
self._new_executability]:
408
changed_ids.update(id_set)
409
# removing implies a kind change
410
changed_kind = set(self._removed_contents)
412
changed_kind.intersection_update(self._new_contents)
413
# Ignore entries that are already known to have changed.
414
changed_kind.difference_update(changed_ids)
415
# to keep only the truly changed ones
416
changed_kind = (t for t in changed_kind
417
if self.tree_kind(t) != self.final_kind(t))
418
# all kind changes will alter the inventory
419
changed_ids.update(changed_kind)
420
# To find entries with changed parent_ids, find parents which existed,
421
# but changed file_id.
422
# Now add all their children to the set.
423
for parent_trans_id in new_file_id:
424
changed_ids.update(self.iter_tree_children(parent_trans_id))
425
return sorted(FinalPaths(self).get_paths(changed_ids))
427
def final_kind(self, trans_id):
428
"""Determine the final file kind, after any changes applied.
430
:return: None if the file does not exist/has no contents. (It is
431
conceivable that a path would be created without the corresponding
432
contents insertion command)
434
if trans_id in self._new_contents:
435
return self._new_contents[trans_id]
436
elif trans_id in self._removed_contents:
439
return self.tree_kind(trans_id)
441
def tree_path(self, trans_id):
442
"""Determine the tree path associated with the trans_id."""
443
return self._tree_id_paths.get(trans_id)
445
def tree_file_id(self, trans_id):
446
"""Determine the file id associated with the trans_id in the tree"""
447
path = self.tree_path(trans_id)
450
# the file is old; the old id is still valid
451
if self._new_root == trans_id:
452
return self._tree.path2id('')
453
return self._tree.path2id(path)
455
def final_file_id(self, trans_id):
456
"""Determine the file id after any changes are applied, or None.
458
None indicates that the file will not be versioned after changes are
462
return self._new_id[trans_id]
464
if trans_id in self._removed_id:
466
return self.tree_file_id(trans_id)
468
def inactive_file_id(self, trans_id):
469
"""Return the inactive file_id associated with a transaction id.
470
That is, the one in the tree or in non_present_ids.
471
The file_id may actually be active, too.
473
file_id = self.tree_file_id(trans_id)
474
if file_id is not None:
476
for key, value in self._non_present_ids.items():
477
if value == trans_id:
480
def final_parent(self, trans_id):
481
"""Determine the parent file_id, after any changes are applied.
483
ROOT_PARENT is returned for the tree root.
486
return self._new_parent[trans_id]
488
return self.get_tree_parent(trans_id)
490
def final_name(self, trans_id):
491
"""Determine the final filename, after all changes are applied."""
493
return self._new_name[trans_id]
496
return os.path.basename(self._tree_id_paths[trans_id])
498
raise NoFinalPath(trans_id, self)
501
"""Return a map of parent: children for known parents.
503
Only new paths and parents of tree files with assigned ids are used.
506
items = list(self._new_parent.items())
507
items.extend((t, self.final_parent(t))
508
for t in list(self._tree_id_paths))
509
for trans_id, parent_id in items:
510
if parent_id not in by_parent:
511
by_parent[parent_id] = set()
512
by_parent[parent_id].add(trans_id)
515
def path_changed(self, trans_id):
516
"""Return True if a trans_id's path has changed."""
517
return (trans_id in self._new_name) or (trans_id in self._new_parent)
519
def new_contents(self, trans_id):
520
return (trans_id in self._new_contents)
522
def find_conflicts(self):
523
"""Find any violations of inventory or filesystem invariants"""
524
if self._done is True:
525
raise ReusingTransform()
527
# ensure all children of all existent parents are known
528
# all children of non-existent parents are known, by definition.
529
self._add_tree_children()
530
by_parent = self.by_parent()
531
conflicts.extend(self._unversioned_parents(by_parent))
532
conflicts.extend(self._parent_loops())
533
conflicts.extend(self._duplicate_entries(by_parent))
534
conflicts.extend(self._duplicate_ids())
535
conflicts.extend(self._parent_type_conflicts(by_parent))
536
conflicts.extend(self._improper_versioning())
537
conflicts.extend(self._executability_conflicts())
538
conflicts.extend(self._overwrite_conflicts())
541
def _check_malformed(self):
542
conflicts = self.find_conflicts()
543
if len(conflicts) != 0:
544
raise MalformedTransform(conflicts=conflicts)
546
def _add_tree_children(self):
547
"""Add all the children of all active parents to the known paths.
549
Active parents are those which gain children, and those which are
550
removed. This is a necessary first step in detecting conflicts.
552
parents = list(self.by_parent())
553
parents.extend([t for t in self._removed_contents if
554
self.tree_kind(t) == 'directory'])
555
for trans_id in self._removed_id:
556
path = self.tree_path(trans_id)
558
if self._tree.stored_kind(path) == 'directory':
559
parents.append(trans_id)
560
elif self.tree_kind(trans_id) == 'directory':
561
parents.append(trans_id)
563
for parent_id in parents:
564
# ensure that all children are registered with the transaction
565
list(self.iter_tree_children(parent_id))
567
def _has_named_child(self, name, parent_id, known_children):
568
"""Does a parent already have a name child.
570
:param name: The searched for name.
572
:param parent_id: The parent for which the check is made.
574
:param known_children: The already known children. This should have
575
been recently obtained from `self.by_parent.get(parent_id)`
576
(or will be if None is passed).
578
if known_children is None:
579
known_children = self.by_parent().get(parent_id, [])
580
for child in known_children:
581
if self.final_name(child) == name:
583
parent_path = self._tree_id_paths.get(parent_id, None)
584
if parent_path is None:
585
# No parent... no children
587
child_path = joinpath(parent_path, name)
588
child_id = self._tree_path_ids.get(child_path, None)
590
# Not known by the tree transform yet, check the filesystem
591
return osutils.lexists(self._tree.abspath(child_path))
593
raise AssertionError('child_id is missing: %s, %s, %s'
594
% (name, parent_id, child_id))
596
def _available_backup_name(self, name, target_id):
597
"""Find an available backup name.
599
:param name: The basename of the file.
601
:param target_id: The directory trans_id where the backup should
604
known_children = self.by_parent().get(target_id, [])
605
return osutils.available_backup_name(
607
lambda base: self._has_named_child(
608
base, target_id, known_children))
610
def _parent_loops(self):
611
"""No entry should be its own ancestor"""
613
for trans_id in self._new_parent:
616
while parent_id != ROOT_PARENT:
619
parent_id = self.final_parent(parent_id)
622
if parent_id == trans_id:
623
conflicts.append(('parent loop', trans_id))
624
if parent_id in seen:
628
def _unversioned_parents(self, by_parent):
629
"""If parent directories are versioned, children must be versioned."""
631
for parent_id, children in by_parent.items():
632
if parent_id == ROOT_PARENT:
634
if self.final_file_id(parent_id) is not None:
636
for child_id in children:
637
if self.final_file_id(child_id) is not None:
638
conflicts.append(('unversioned parent', parent_id))
642
def _improper_versioning(self):
643
"""Cannot version a file with no contents, or a bad type.
645
However, existing entries with no contents are okay.
648
for trans_id in self._new_id:
649
kind = self.final_kind(trans_id)
650
if kind == 'symlink' and not self._tree.supports_symlinks():
651
# Ignore symlinks as they are not supported on this platform
654
conflicts.append(('versioning no contents', trans_id))
656
if not self._tree.versionable_kind(kind):
657
conflicts.append(('versioning bad kind', trans_id, kind))
660
def _executability_conflicts(self):
661
"""Check for bad executability changes.
663
Only versioned files may have their executability set, because
664
1. only versioned entries can have executability under windows
665
2. only files can be executable. (The execute bit on a directory
666
does not indicate searchability)
669
for trans_id in self._new_executability:
670
if self.final_file_id(trans_id) is None:
671
conflicts.append(('unversioned executability', trans_id))
673
if self.final_kind(trans_id) != "file":
674
conflicts.append(('non-file executability', trans_id))
677
def _overwrite_conflicts(self):
678
"""Check for overwrites (not permitted on Win32)"""
680
for trans_id in self._new_contents:
681
if self.tree_kind(trans_id) is None:
683
if trans_id not in self._removed_contents:
684
conflicts.append(('overwrite', trans_id,
685
self.final_name(trans_id)))
688
def _duplicate_entries(self, by_parent):
689
"""No directory may have two entries with the same name."""
691
if (self._new_name, self._new_parent) == ({}, {}):
693
for children in by_parent.values():
695
for child_tid in children:
696
name = self.final_name(child_tid)
698
# Keep children only if they still exist in the end
699
if not self._case_sensitive_target:
701
name_ids.append((name, child_tid))
705
for name, trans_id in name_ids:
706
kind = self.final_kind(trans_id)
707
file_id = self.final_file_id(trans_id)
708
if kind is None and file_id is None:
710
if name == last_name:
711
conflicts.append(('duplicate', last_trans_id, trans_id,
714
last_trans_id = trans_id
717
def _duplicate_ids(self):
718
"""Each inventory id may only be used once"""
721
all_ids = self._tree.all_file_ids()
722
except errors.UnsupportedOperation:
723
# it's okay for non-file-id trees to raise UnsupportedOperation.
725
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
727
active_tree_ids = all_ids.difference(removed_tree_ids)
728
for trans_id, file_id in self._new_id.items():
729
if file_id in active_tree_ids:
730
path = self._tree.id2path(file_id)
731
old_trans_id = self.trans_id_tree_path(path)
732
conflicts.append(('duplicate id', old_trans_id, trans_id))
735
def _parent_type_conflicts(self, by_parent):
736
"""Children must have a directory parent"""
738
for parent_id, children in by_parent.items():
739
if parent_id == ROOT_PARENT:
742
for child_id in children:
743
if self.final_kind(child_id) is not None:
748
# There is at least a child, so we need an existing directory to
750
kind = self.final_kind(parent_id)
752
# The directory will be deleted
753
conflicts.append(('missing parent', parent_id))
754
elif kind != "directory":
755
# Meh, we need a *directory* to put something in it
756
conflicts.append(('non-directory parent', parent_id))
759
def _set_executability(self, path, trans_id):
760
"""Set the executability of versioned files """
761
if self._tree._supports_executable():
762
new_executability = self._new_executability[trans_id]
763
abspath = self._tree.abspath(path)
764
current_mode = os.stat(abspath).st_mode
765
if new_executability:
768
to_mode = current_mode | (0o100 & ~umask)
769
# Enable x-bit for others only if they can read it.
770
if current_mode & 0o004:
771
to_mode |= 0o001 & ~umask
772
if current_mode & 0o040:
773
to_mode |= 0o010 & ~umask
775
to_mode = current_mode & ~0o111
776
osutils.chmod_if_possible(abspath, to_mode)
778
def _new_entry(self, name, parent_id, file_id):
779
"""Helper function to create a new filesystem entry."""
780
trans_id = self.create_path(name, parent_id)
781
if file_id is not None:
782
self.version_file(file_id, trans_id)
785
def new_file(self, name, parent_id, contents, file_id=None,
786
executable=None, sha1=None):
787
"""Convenience method to create files.
789
name is the name of the file to create.
790
parent_id is the transaction id of the parent directory of the file.
791
contents is an iterator of bytestrings, which will be used to produce
793
:param file_id: The inventory ID of the file, if it is to be versioned.
794
:param executable: Only valid when a file_id has been supplied.
796
trans_id = self._new_entry(name, parent_id, file_id)
797
# TODO: rather than scheduling a set_executable call,
798
# have create_file create the file with the right mode.
799
self.create_file(contents, trans_id, sha1=sha1)
800
if executable is not None:
801
self.set_executability(executable, trans_id)
804
def new_directory(self, name, parent_id, file_id=None):
805
"""Convenience method to create directories.
807
name is the name of the directory to create.
808
parent_id is the transaction id of the parent directory of the
810
file_id is the inventory ID of the directory, if it is to be versioned.
812
trans_id = self._new_entry(name, parent_id, file_id)
813
self.create_directory(trans_id)
816
def new_symlink(self, name, parent_id, target, file_id=None):
817
"""Convenience method to create symbolic link.
819
name is the name of the symlink to create.
820
parent_id is the transaction id of the parent directory of the symlink.
821
target is a bytestring of the target of the symlink.
822
file_id is the inventory ID of the file, if it is to be versioned.
824
trans_id = self._new_entry(name, parent_id, file_id)
825
self.create_symlink(target, trans_id)
828
def new_orphan(self, trans_id, parent_id):
829
"""Schedule an item to be orphaned.
831
When a directory is about to be removed, its children, if they are not
832
versioned are moved out of the way: they don't have a parent anymore.
834
:param trans_id: The trans_id of the existing item.
835
:param parent_id: The parent trans_id of the item.
837
raise NotImplementedError(self.new_orphan)
839
def _get_potential_orphans(self, dir_id):
840
"""Find the potential orphans in a directory.
842
A directory can't be safely deleted if there are versioned files in it.
843
If all the contained files are unversioned then they can be orphaned.
845
The 'None' return value means that the directory contains at least one
846
versioned file and should not be deleted.
848
:param dir_id: The directory trans id.
850
:return: A list of the orphan trans ids or None if at least one
851
versioned file is present.
854
# Find the potential orphans, stop if one item should be kept
855
for child_tid in self.by_parent()[dir_id]:
856
if child_tid in self._removed_contents:
857
# The child is removed as part of the transform. Since it was
858
# versioned before, it's not an orphan
860
elif self.final_file_id(child_tid) is None:
861
# The child is not versioned
862
orphans.append(child_tid)
864
# We have a versioned file here, searching for orphans is
870
def _affected_ids(self):
871
"""Return the set of transform ids affected by the transform"""
872
trans_ids = set(self._removed_id)
873
trans_ids.update(self._new_id)
874
trans_ids.update(self._removed_contents)
875
trans_ids.update(self._new_contents)
876
trans_ids.update(self._new_executability)
877
trans_ids.update(self._new_name)
878
trans_ids.update(self._new_parent)
881
def _get_file_id_maps(self):
882
"""Return mapping of file_ids to trans_ids in the to and from states"""
883
trans_ids = self._affected_ids()
886
# Build up two dicts: trans_ids associated with file ids in the
887
# FROM state, vs the TO state.
888
for trans_id in trans_ids:
889
from_file_id = self.tree_file_id(trans_id)
890
if from_file_id is not None:
891
from_trans_ids[from_file_id] = trans_id
892
to_file_id = self.final_file_id(trans_id)
893
if to_file_id is not None:
894
to_trans_ids[to_file_id] = trans_id
895
return from_trans_ids, to_trans_ids
897
def _from_file_data(self, from_trans_id, from_versioned, from_path):
898
"""Get data about a file in the from (tree) state
900
Return a (name, parent, kind, executable) tuple
902
from_path = self._tree_id_paths.get(from_trans_id)
904
# get data from working tree if versioned
905
from_entry = next(self._tree.iter_entries_by_dir(
906
specific_files=[from_path]))[1]
907
from_name = from_entry.name
908
from_parent = from_entry.parent_id
911
if from_path is None:
912
# File does not exist in FROM state
916
# File exists, but is not versioned. Have to use path-
918
from_name = os.path.basename(from_path)
919
tree_parent = self.get_tree_parent(from_trans_id)
920
from_parent = self.tree_file_id(tree_parent)
921
if from_path is not None:
922
from_kind, from_executable, from_stats = \
923
self._tree._comparison_data(from_entry, from_path)
926
from_executable = False
927
return from_name, from_parent, from_kind, from_executable
929
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
930
"""Get data about a file in the to (target) state
932
Return a (name, parent, kind, executable) tuple
934
to_name = self.final_name(to_trans_id)
935
to_kind = self.final_kind(to_trans_id)
936
to_parent = self.final_file_id(self.final_parent(to_trans_id))
937
if to_trans_id in self._new_executability:
938
to_executable = self._new_executability[to_trans_id]
939
elif to_trans_id == from_trans_id:
940
to_executable = from_executable
942
to_executable = False
943
return to_name, to_parent, to_kind, to_executable
945
def iter_changes(self):
946
"""Produce output in the same format as Tree.iter_changes.
948
Will produce nonsensical results if invoked while inventory/filesystem
949
conflicts (as reported by TreeTransform.find_conflicts()) are present.
951
This reads the Transform, but only reproduces changes involving a
952
file_id. Files that are not versioned in either of the FROM or TO
953
states are not reflected.
955
final_paths = FinalPaths(self)
956
from_trans_ids, to_trans_ids = self._get_file_id_maps()
958
# Now iterate through all active file_ids
959
for file_id in set(from_trans_ids).union(to_trans_ids):
961
from_trans_id = from_trans_ids.get(file_id)
962
# find file ids, and determine versioning state
963
if from_trans_id is None:
964
from_versioned = False
965
from_trans_id = to_trans_ids[file_id]
967
from_versioned = True
968
to_trans_id = to_trans_ids.get(file_id)
969
if to_trans_id is None:
971
to_trans_id = from_trans_id
975
if not from_versioned:
978
from_path = self._tree_id_paths.get(from_trans_id)
982
to_path = final_paths.get_path(to_trans_id)
984
from_name, from_parent, from_kind, from_executable = \
985
self._from_file_data(from_trans_id, from_versioned, from_path)
987
to_name, to_parent, to_kind, to_executable = \
988
self._to_file_data(to_trans_id, from_trans_id, from_executable)
990
if from_kind != to_kind:
992
elif to_kind in ('file', 'symlink') and (
993
to_trans_id != from_trans_id
994
or to_trans_id in self._new_contents):
996
if (not modified and from_versioned == to_versioned
997
and from_parent == to_parent and from_name == to_name
998
and from_executable == to_executable):
1002
file_id, (from_path, to_path), modified,
1003
(from_versioned, to_versioned),
1004
(from_parent, to_parent),
1005
(from_name, to_name),
1006
(from_kind, to_kind),
1007
(from_executable, to_executable)))
1010
return (c.path[0] or '', c.path[1] or '')
1011
return iter(sorted(results, key=path_key))
1013
def get_preview_tree(self):
1014
"""Return a tree representing the result of the transform.
1016
The tree is a snapshot, and altering the TreeTransform will invalidate
1019
return _PreviewTree(self)
1021
def commit(self, branch, message, merge_parents=None, strict=False,
1022
timestamp=None, timezone=None, committer=None, authors=None,
1023
revprops=None, revision_id=None):
1024
"""Commit the result of this TreeTransform to a branch.
1026
:param branch: The branch to commit to.
1027
:param message: The message to attach to the commit.
1028
:param merge_parents: Additional parent revision-ids specified by
1030
:param strict: If True, abort the commit if there are unversioned
1032
:param timestamp: if not None, seconds-since-epoch for the time and
1033
date. (May be a float.)
1034
:param timezone: Optional timezone for timestamp, as an offset in
1036
:param committer: Optional committer in email-id format.
1037
(e.g. "J Random Hacker <jrandom@example.com>")
1038
:param authors: Optional list of authors in email-id format.
1039
:param revprops: Optional dictionary of revision properties.
1040
:param revision_id: Optional revision id. (Specifying a revision-id
1041
may reduce performance for some non-native formats.)
1042
:return: The revision_id of the revision committed.
1044
self._check_malformed()
1046
unversioned = set(self._new_contents).difference(set(self._new_id))
1047
for trans_id in unversioned:
1048
if self.final_file_id(trans_id) is None:
1049
raise errors.StrictCommitFailed()
1051
revno, last_rev_id = branch.last_revision_info()
1052
if last_rev_id == _mod_revision.NULL_REVISION:
1053
if merge_parents is not None:
1054
raise ValueError('Cannot supply merge parents for first'
1058
parent_ids = [last_rev_id]
1059
if merge_parents is not None:
1060
parent_ids.extend(merge_parents)
1061
if self._tree.get_revision_id() != last_rev_id:
1062
raise ValueError('TreeTransform not based on branch basis: %s' %
1063
self._tree.get_revision_id().decode('utf-8'))
1064
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1065
builder = branch.get_commit_builder(parent_ids,
1066
timestamp=timestamp,
1068
committer=committer,
1070
revision_id=revision_id)
1071
preview = self.get_preview_tree()
1072
list(builder.record_iter_changes(preview, last_rev_id,
1073
self.iter_changes()))
1074
builder.finish_inventory()
1075
revision_id = builder.commit(message)
1076
branch.set_last_revision_info(revno + 1, revision_id)
1079
def _text_parent(self, trans_id):
1080
path = self.tree_path(trans_id)
1082
if path is None or self._tree.kind(path) != 'file':
1084
except errors.NoSuchFile:
1088
def _get_parents_texts(self, trans_id):
1089
"""Get texts for compression parents of this file."""
1090
path = self._text_parent(trans_id)
1093
return (self._tree.get_file_text(path),)
1095
def _get_parents_lines(self, trans_id):
1096
"""Get lines for compression parents of this file."""
1097
path = self._text_parent(trans_id)
1100
return (self._tree.get_file_lines(path),)
1102
def serialize(self, serializer):
1103
"""Serialize this TreeTransform.
1105
:param serializer: A Serialiser like pack.ContainerSerializer.
1107
new_name = {k.encode('utf-8'): v.encode('utf-8')
1108
for k, v in self._new_name.items()}
1109
new_parent = {k.encode('utf-8'): v.encode('utf-8')
1110
for k, v in self._new_parent.items()}
1111
new_id = {k.encode('utf-8'): v
1112
for k, v in self._new_id.items()}
1113
new_executability = {k.encode('utf-8'): int(v)
1114
for k, v in self._new_executability.items()}
1115
tree_path_ids = {k.encode('utf-8'): v.encode('utf-8')
1116
for k, v in self._tree_path_ids.items()}
1117
non_present_ids = {k: v.encode('utf-8')
1118
for k, v in self._non_present_ids.items()}
1119
removed_contents = [trans_id.encode('utf-8')
1120
for trans_id in self._removed_contents]
1121
removed_id = [trans_id.encode('utf-8')
1122
for trans_id in self._removed_id]
1124
b'_id_number': self._id_number,
1125
b'_new_name': new_name,
1126
b'_new_parent': new_parent,
1127
b'_new_executability': new_executability,
1129
b'_tree_path_ids': tree_path_ids,
1130
b'_removed_id': removed_id,
1131
b'_removed_contents': removed_contents,
1132
b'_non_present_ids': non_present_ids,
1134
yield serializer.bytes_record(bencode.bencode(attribs),
1136
for trans_id, kind in sorted(self._new_contents.items()):
1138
with open(self._limbo_name(trans_id), 'rb') as cur_file:
1139
lines = cur_file.readlines()
1140
parents = self._get_parents_lines(trans_id)
1141
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1142
content = b''.join(mpdiff.to_patch())
1143
if kind == 'directory':
1145
if kind == 'symlink':
1146
content = self._read_symlink_target(trans_id)
1147
if not isinstance(content, bytes):
1148
content = content.encode('utf-8')
1149
yield serializer.bytes_record(
1150
content, ((trans_id.encode('utf-8'), kind.encode('ascii')),))
1152
def deserialize(self, records):
1153
"""Deserialize a stored TreeTransform.
1155
:param records: An iterable of (names, content) tuples, as per
1156
pack.ContainerPushParser.
1158
names, content = next(records)
1159
attribs = bencode.bdecode(content)
1160
self._id_number = attribs[b'_id_number']
1161
self._new_name = {k.decode('utf-8'): v.decode('utf-8')
1162
for k, v in attribs[b'_new_name'].items()}
1163
self._new_parent = {k.decode('utf-8'): v.decode('utf-8')
1164
for k, v in attribs[b'_new_parent'].items()}
1165
self._new_executability = {
1166
k.decode('utf-8'): bool(v)
1167
for k, v in attribs[b'_new_executability'].items()}
1168
self._new_id = {k.decode('utf-8'): v
1169
for k, v in attribs[b'_new_id'].items()}
1170
self._r_new_id = {v: k for k, v in self._new_id.items()}
1171
self._tree_path_ids = {}
1172
self._tree_id_paths = {}
1173
for bytepath, trans_id in attribs[b'_tree_path_ids'].items():
1174
path = bytepath.decode('utf-8')
1175
trans_id = trans_id.decode('utf-8')
1176
self._tree_path_ids[path] = trans_id
1177
self._tree_id_paths[trans_id] = path
1178
self._removed_id = {trans_id.decode('utf-8')
1179
for trans_id in attribs[b'_removed_id']}
1180
self._removed_contents = set(
1181
trans_id.decode('utf-8')
1182
for trans_id in attribs[b'_removed_contents'])
1183
self._non_present_ids = {
1184
k: v.decode('utf-8')
1185
for k, v in attribs[b'_non_present_ids'].items()}
1186
for ((trans_id, kind),), content in records:
1187
trans_id = trans_id.decode('utf-8')
1188
kind = kind.decode('ascii')
1190
mpdiff = multiparent.MultiParent.from_patch(content)
1191
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1192
self.create_file(lines, trans_id)
1193
if kind == 'directory':
1194
self.create_directory(trans_id)
1195
if kind == 'symlink':
1196
self.create_symlink(content.decode('utf-8'), trans_id)
1198
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1199
"""Schedule creation of a new file.
1203
:param contents: an iterator of strings, all of which will be written
1204
to the target destination.
1205
:param trans_id: TreeTransform handle
1206
:param mode_id: If not None, force the mode of the target file to match
1207
the mode of the object referenced by mode_id.
1208
Otherwise, we will try to preserve mode bits of an existing file.
1209
:param sha1: If the sha1 of this content is already known, pass it in.
1210
We can use it to prevent future sha1 computations.
1212
raise NotImplementedError(self.create_file)
1214
def create_directory(self, trans_id):
1215
"""Schedule creation of a new directory.
1217
See also new_directory.
1219
raise NotImplementedError(self.create_directory)
1221
def create_symlink(self, target, trans_id):
1222
"""Schedule creation of a new symbolic link.
1224
target is a bytestring.
1225
See also new_symlink.
1227
raise NotImplementedError(self.create_symlink)
1229
def create_hardlink(self, path, trans_id):
1230
"""Schedule creation of a hard link"""
1231
raise NotImplementedError(self.create_hardlink)
1233
def cancel_creation(self, trans_id):
1234
"""Cancel the creation of new file contents."""
1235
raise NotImplementedError(self.cancel_creation)
1238
class DiskTreeTransform(TreeTransformBase):
1239
"""Tree transform storing its contents on disk."""
1241
def __init__(self, tree, limbodir, pb=None, case_sensitive=True):
1243
:param tree: The tree that will be transformed, but not necessarily
1245
:param limbodir: A directory where new files can be stored until
1246
they are installed in their proper places
1248
:param case_sensitive: If True, the target of the transform is
1249
case sensitive, not just case preserving.
1251
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1252
self._limbodir = limbodir
1253
self._deletiondir = None
1254
# A mapping of transform ids to their limbo filename
1255
self._limbo_files = {}
1256
self._possibly_stale_limbo_files = set()
1257
# A mapping of transform ids to a set of the transform ids of children
1258
# that their limbo directory has
1259
self._limbo_children = {}
1260
# Map transform ids to maps of child filename to child transform id
1261
self._limbo_children_names = {}
1262
# List of transform ids that need to be renamed from limbo into place
1263
self._needs_rename = set()
1264
self._creation_mtime = None
1265
self._create_symlinks = osutils.supports_symlinks(self._limbodir)
1268
"""Release the working tree lock, if held, clean up limbo dir.
1270
This is required if apply has not been invoked, but can be invoked
1273
if self._tree is None:
1276
limbo_paths = list(self._limbo_files.values())
1277
limbo_paths.extend(self._possibly_stale_limbo_files)
1278
limbo_paths.sort(reverse=True)
1279
for path in limbo_paths:
1282
except OSError as e:
1283
if e.errno != errno.ENOENT:
1285
# XXX: warn? perhaps we just got interrupted at an
1286
# inconvenient moment, but perhaps files are disappearing
1289
delete_any(self._limbodir)
1291
# We don't especially care *why* the dir is immortal.
1292
raise ImmortalLimbo(self._limbodir)
1294
if self._deletiondir is not None:
1295
delete_any(self._deletiondir)
1297
raise errors.ImmortalPendingDeletion(self._deletiondir)
1299
TreeTransformBase.finalize(self)
1301
def _limbo_supports_executable(self):
1302
"""Check if the limbo path supports the executable bit."""
1303
return osutils.supports_executable(self._limbodir)
1305
def _limbo_name(self, trans_id):
1306
"""Generate the limbo name of a file"""
1307
limbo_name = self._limbo_files.get(trans_id)
1308
if limbo_name is None:
1309
limbo_name = self._generate_limbo_path(trans_id)
1310
self._limbo_files[trans_id] = limbo_name
1313
def _generate_limbo_path(self, trans_id):
1314
"""Generate a limbo path using the trans_id as the relative path.
1316
This is suitable as a fallback, and when the transform should not be
1317
sensitive to the path encoding of the limbo directory.
1319
self._needs_rename.add(trans_id)
1320
return pathjoin(self._limbodir, trans_id)
1322
def adjust_path(self, name, parent, trans_id):
1323
previous_parent = self._new_parent.get(trans_id)
1324
previous_name = self._new_name.get(trans_id)
1325
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1326
if (trans_id in self._limbo_files
1327
and trans_id not in self._needs_rename):
1328
self._rename_in_limbo([trans_id])
1329
if previous_parent != parent:
1330
self._limbo_children[previous_parent].remove(trans_id)
1331
if previous_parent != parent or previous_name != name:
1332
del self._limbo_children_names[previous_parent][previous_name]
1334
def _rename_in_limbo(self, trans_ids):
1335
"""Fix limbo names so that the right final path is produced.
1337
This means we outsmarted ourselves-- we tried to avoid renaming
1338
these files later by creating them with their final names in their
1339
final parents. But now the previous name or parent is no longer
1340
suitable, so we have to rename them.
1342
Even for trans_ids that have no new contents, we must remove their
1343
entries from _limbo_files, because they are now stale.
1345
for trans_id in trans_ids:
1346
old_path = self._limbo_files[trans_id]
1347
self._possibly_stale_limbo_files.add(old_path)
1348
del self._limbo_files[trans_id]
1349
if trans_id not in self._new_contents:
1351
new_path = self._limbo_name(trans_id)
1352
os.rename(old_path, new_path)
1353
self._possibly_stale_limbo_files.remove(old_path)
1354
for descendant in self._limbo_descendants(trans_id):
1355
desc_path = self._limbo_files[descendant]
1356
desc_path = new_path + desc_path[len(old_path):]
1357
self._limbo_files[descendant] = desc_path
1359
def _limbo_descendants(self, trans_id):
1360
"""Return the set of trans_ids whose limbo paths descend from this."""
1361
descendants = set(self._limbo_children.get(trans_id, []))
1362
for descendant in list(descendants):
1363
descendants.update(self._limbo_descendants(descendant))
1366
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1367
"""Schedule creation of a new file.
1371
:param contents: an iterator of strings, all of which will be written
1372
to the target destination.
1373
:param trans_id: TreeTransform handle
1374
:param mode_id: If not None, force the mode of the target file to match
1375
the mode of the object referenced by mode_id.
1376
Otherwise, we will try to preserve mode bits of an existing file.
1377
:param sha1: If the sha1 of this content is already known, pass it in.
1378
We can use it to prevent future sha1 computations.
1380
name = self._limbo_name(trans_id)
1381
with open(name, 'wb') as f:
1382
unique_add(self._new_contents, trans_id, 'file')
1383
f.writelines(contents)
1384
self._set_mtime(name)
1385
self._set_mode(trans_id, mode_id, S_ISREG)
1386
# It is unfortunate we have to use lstat instead of fstat, but we just
1387
# used utime and chmod on the file, so we need the accurate final
1389
if sha1 is not None:
1390
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1392
def _read_symlink_target(self, trans_id):
1393
return os.readlink(self._limbo_name(trans_id))
1395
def _set_mtime(self, path):
1396
"""All files that are created get the same mtime.
1398
This time is set by the first object to be created.
1400
if self._creation_mtime is None:
1401
self._creation_mtime = time.time()
1402
os.utime(path, (self._creation_mtime, self._creation_mtime))
1404
def create_hardlink(self, path, trans_id):
1405
"""Schedule creation of a hard link"""
1406
name = self._limbo_name(trans_id)
1409
except OSError as e:
1410
if e.errno != errno.EPERM:
1412
raise errors.HardLinkNotSupported(path)
1414
unique_add(self._new_contents, trans_id, 'file')
1415
except BaseException:
1416
# Clean up the file, it never got registered so
1417
# TreeTransform.finalize() won't clean it up.
1421
def create_directory(self, trans_id):
1422
"""Schedule creation of a new directory.
1424
See also new_directory.
1426
os.mkdir(self._limbo_name(trans_id))
1427
unique_add(self._new_contents, trans_id, 'directory')
1429
def create_symlink(self, target, trans_id):
1430
"""Schedule creation of a new symbolic link.
1432
target is a bytestring.
1433
See also new_symlink.
1435
if self._create_symlinks:
1436
os.symlink(target, self._limbo_name(trans_id))
1439
path = FinalPaths(self).get_path(trans_id)
1443
'Unable to create symlink "%s" on this filesystem.' % (path,))
1444
# We add symlink to _new_contents even if they are unsupported
1445
# and not created. These entries are subsequently used to avoid
1446
# conflicts on platforms that don't support symlink
1447
unique_add(self._new_contents, trans_id, 'symlink')
1449
def cancel_creation(self, trans_id):
1450
"""Cancel the creation of new file contents."""
1451
del self._new_contents[trans_id]
1452
if trans_id in self._observed_sha1s:
1453
del self._observed_sha1s[trans_id]
1454
children = self._limbo_children.get(trans_id)
1455
# if this is a limbo directory with children, move them before removing
1457
if children is not None:
1458
self._rename_in_limbo(children)
1459
del self._limbo_children[trans_id]
1460
del self._limbo_children_names[trans_id]
1461
delete_any(self._limbo_name(trans_id))
1463
def new_orphan(self, trans_id, parent_id):
1464
conf = self._tree.get_config_stack()
1465
handle_orphan = conf.get('transform.orphan_policy')
1466
handle_orphan(self, trans_id, parent_id)
1469
class OrphaningError(errors.BzrError):
1471
# Only bugs could lead to such exception being seen by the user
1472
internal_error = True
1473
_fmt = "Error while orphaning %s in %s directory"
1475
def __init__(self, orphan, parent):
1476
errors.BzrError.__init__(self)
1477
self.orphan = orphan
1478
self.parent = parent
1481
class OrphaningForbidden(OrphaningError):
1483
_fmt = "Policy: %s doesn't allow creating orphans."
1485
def __init__(self, policy):
1486
errors.BzrError.__init__(self)
1487
self.policy = policy
1490
def move_orphan(tt, orphan_id, parent_id):
1491
"""See TreeTransformBase.new_orphan.
1493
This creates a new orphan in the `brz-orphans` dir at the root of the
1496
:param tt: The TreeTransform orphaning `trans_id`.
1498
:param orphan_id: The trans id that should be orphaned.
1500
:param parent_id: The orphan parent trans id.
1502
# Add the orphan dir if it doesn't exist
1503
orphan_dir_basename = 'brz-orphans'
1504
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1505
if tt.final_kind(od_id) is None:
1506
tt.create_directory(od_id)
1507
parent_path = tt._tree_id_paths[parent_id]
1508
# Find a name that doesn't exist yet in the orphan dir
1509
actual_name = tt.final_name(orphan_id)
1510
new_name = tt._available_backup_name(actual_name, od_id)
1511
tt.adjust_path(new_name, od_id, orphan_id)
1512
trace.warning('%s has been orphaned in %s'
1513
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1516
def refuse_orphan(tt, orphan_id, parent_id):
1517
"""See TreeTransformBase.new_orphan.
1519
This refuses to create orphan, letting the caller handle the conflict.
1521
raise OrphaningForbidden('never')
1524
orphaning_registry = registry.Registry()
1525
orphaning_registry.register(
1526
u'conflict', refuse_orphan,
1527
'Leave orphans in place and create a conflict on the directory.')
1528
orphaning_registry.register(
1529
u'move', move_orphan,
1530
'Move orphans into the brz-orphans directory.')
1531
orphaning_registry._set_default_key(u'conflict')
1534
opt_transform_orphan = _mod_config.RegistryOption(
1535
'transform.orphan_policy', orphaning_registry,
1536
help='Policy for orphaned files during transform operations.',
1540
class TreeTransform(DiskTreeTransform):
1541
"""Represent a tree transformation.
1543
This object is designed to support incremental generation of the transform,
1546
However, it gives optimum performance when parent directories are created
1547
before their contents. The transform is then able to put child files
1548
directly in their parent directory, avoiding later renames.
1550
It is easy to produce malformed transforms, but they are generally
1551
harmless. Attempting to apply a malformed transform will cause an
1552
exception to be raised before any modifications are made to the tree.
1554
Many kinds of malformed transforms can be corrected with the
1555
resolve_conflicts function. The remaining ones indicate programming error,
1556
such as trying to create a file with no path.
1558
Two sets of file creation methods are supplied. Convenience methods are:
1563
These are composed of the low-level methods:
1565
* create_file or create_directory or create_symlink
1569
Transform/Transaction ids
1570
-------------------------
1571
trans_ids are temporary ids assigned to all files involved in a transform.
1572
It's possible, even common, that not all files in the Tree have trans_ids.
1574
trans_ids are used because filenames and file_ids are not good enough
1575
identifiers; filenames change, and not all files have file_ids. File-ids
1576
are also associated with trans-ids, so that moving a file moves its
1579
trans_ids are only valid for the TreeTransform that generated them.
1583
Limbo is a temporary directory use to hold new versions of files.
1584
Files are added to limbo by create_file, create_directory, create_symlink,
1585
and their convenience variants (new_*). Files may be removed from limbo
1586
using cancel_creation. Files are renamed from limbo into their final
1587
location as part of TreeTransform.apply
1589
Limbo must be cleaned up, by either calling TreeTransform.apply or
1590
calling TreeTransform.finalize.
1592
Files are placed into limbo inside their parent directories, where
1593
possible. This reduces subsequent renames, and makes operations involving
1594
lots of files faster. This optimization is only possible if the parent
1595
directory is created *before* creating any of its children, so avoid
1596
creating children before parents, where possible.
1600
This temporary directory is used by _FileMover for storing files that are
1601
about to be deleted. In case of rollback, the files will be restored.
1602
FileMover does not delete files until it is sure that a rollback will not
1606
def __init__(self, tree, pb=None):
1607
"""Note: a tree_write lock is taken on the tree.
1609
Use TreeTransform.finalize() to release the lock (can be omitted if
1610
TreeTransform.apply() called).
1612
tree.lock_tree_write()
1614
limbodir = urlutils.local_path_from_url(
1615
tree._transport.abspath('limbo'))
1616
osutils.ensure_empty_directory_exists(
1618
errors.ExistingLimbo)
1619
deletiondir = urlutils.local_path_from_url(
1620
tree._transport.abspath('pending-deletion'))
1621
osutils.ensure_empty_directory_exists(
1623
errors.ExistingPendingDeletion)
1624
except BaseException:
1628
# Cache of realpath results, to speed up canonical_path
1629
self._realpaths = {}
1630
# Cache of relpath results, to speed up canonical_path
1632
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1633
tree.case_sensitive)
1634
self._deletiondir = deletiondir
1636
def canonical_path(self, path):
1637
"""Get the canonical tree-relative path"""
1638
# don't follow final symlinks
1639
abs = self._tree.abspath(path)
1640
if abs in self._relpaths:
1641
return self._relpaths[abs]
1642
dirname, basename = os.path.split(abs)
1643
if dirname not in self._realpaths:
1644
self._realpaths[dirname] = os.path.realpath(dirname)
1645
dirname = self._realpaths[dirname]
1646
abs = pathjoin(dirname, basename)
1647
if dirname in self._relpaths:
1648
relpath = pathjoin(self._relpaths[dirname], basename)
1649
relpath = relpath.rstrip('/\\')
1651
relpath = self._tree.relpath(abs)
1652
self._relpaths[abs] = relpath
1655
def tree_kind(self, trans_id):
1656
"""Determine the file kind in the working tree.
1658
:returns: The file kind or None if the file does not exist
1660
path = self._tree_id_paths.get(trans_id)
1664
return file_kind(self._tree.abspath(path))
1665
except errors.NoSuchFile:
1668
def _set_mode(self, trans_id, mode_id, typefunc):
1669
"""Set the mode of new file contents.
1670
The mode_id is the existing file to get the mode from (often the same
1671
as trans_id). The operation is only performed if there's a mode match
1672
according to typefunc.
1677
old_path = self._tree_id_paths[mode_id]
1681
mode = os.stat(self._tree.abspath(old_path)).st_mode
1682
except OSError as e:
1683
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1684
# Either old_path doesn't exist, or the parent of the
1685
# target is not a directory (but will be one eventually)
1686
# Either way, we know it doesn't exist *right now*
1687
# See also bug #248448
1692
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1694
def iter_tree_children(self, parent_id):
1695
"""Iterate through the entry's tree children, if any"""
1697
path = self._tree_id_paths[parent_id]
1701
children = os.listdir(self._tree.abspath(path))
1702
except OSError as e:
1703
if not (osutils._is_error_enotdir(e) or
1704
e.errno in (errno.ENOENT, errno.ESRCH)):
1708
for child in children:
1709
childpath = joinpath(path, child)
1710
if self._tree.is_control_filename(childpath):
1712
yield self.trans_id_tree_path(childpath)
1714
def _generate_limbo_path(self, trans_id):
1715
"""Generate a limbo path using the final path if possible.
1717
This optimizes the performance of applying the tree transform by
1718
avoiding renames. These renames can be avoided only when the parent
1719
directory is already scheduled for creation.
1721
If the final path cannot be used, falls back to using the trans_id as
1724
parent = self._new_parent.get(trans_id)
1725
# if the parent directory is already in limbo (e.g. when building a
1726
# tree), choose a limbo name inside the parent, to reduce further
1728
use_direct_path = False
1729
if self._new_contents.get(parent) == 'directory':
1730
filename = self._new_name.get(trans_id)
1731
if filename is not None:
1732
if parent not in self._limbo_children:
1733
self._limbo_children[parent] = set()
1734
self._limbo_children_names[parent] = {}
1735
use_direct_path = True
1736
# the direct path can only be used if no other file has
1737
# already taken this pathname, i.e. if the name is unused, or
1738
# if it is already associated with this trans_id.
1739
elif self._case_sensitive_target:
1740
if (self._limbo_children_names[parent].get(filename)
1741
in (trans_id, None)):
1742
use_direct_path = True
1744
for l_filename, l_trans_id in (
1745
self._limbo_children_names[parent].items()):
1746
if l_trans_id == trans_id:
1748
if l_filename.lower() == filename.lower():
1751
use_direct_path = True
1753
if not use_direct_path:
1754
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1756
limbo_name = pathjoin(self._limbo_files[parent], filename)
1757
self._limbo_children[parent].add(trans_id)
1758
self._limbo_children_names[parent][filename] = trans_id
1761
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1762
"""Apply all changes to the inventory and filesystem.
1764
If filesystem or inventory conflicts are present, MalformedTransform
1767
If apply succeeds, finalize is not necessary.
1769
:param no_conflicts: if True, the caller guarantees there are no
1770
conflicts, so no check is made.
1771
:param precomputed_delta: An inventory delta to use instead of
1773
:param _mover: Supply an alternate FileMover, for testing
1775
for hook in MutableTree.hooks['pre_transform']:
1776
hook(self._tree, self)
1777
if not no_conflicts:
1778
self._check_malformed()
1779
with ui.ui_factory.nested_progress_bar() as child_pb:
1780
if precomputed_delta is None:
1781
child_pb.update(gettext('Apply phase'), 0, 2)
1782
inventory_delta = self._generate_inventory_delta()
1785
inventory_delta = precomputed_delta
1788
mover = _FileMover()
1792
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1793
self._apply_removals(mover)
1794
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1795
modified_paths = self._apply_insertions(mover)
1796
except BaseException:
1800
mover.apply_deletions()
1801
if self.final_file_id(self.root) is None:
1802
inventory_delta = [e for e in inventory_delta if e[0] != '']
1803
self._tree.apply_inventory_delta(inventory_delta)
1804
self._apply_observed_sha1s()
1807
return _TransformResults(modified_paths, self.rename_count)
1809
def _generate_inventory_delta(self):
1810
"""Generate an inventory delta for the current transform."""
1811
inventory_delta = []
1812
new_paths = self._inventory_altered()
1813
total_entries = len(new_paths) + len(self._removed_id)
1814
with ui.ui_factory.nested_progress_bar() as child_pb:
1815
for num, trans_id in enumerate(self._removed_id):
1817
child_pb.update(gettext('removing file'),
1819
if trans_id == self._new_root:
1820
file_id = self._tree.path2id('')
1822
file_id = self.tree_file_id(trans_id)
1823
# File-id isn't really being deleted, just moved
1824
if file_id in self._r_new_id:
1826
path = self._tree_id_paths[trans_id]
1827
inventory_delta.append((path, None, file_id, None))
1828
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1830
for num, (path, trans_id) in enumerate(new_paths):
1832
child_pb.update(gettext('adding file'),
1833
num + len(self._removed_id), total_entries)
1834
file_id = new_path_file_ids[trans_id]
1837
kind = self.final_kind(trans_id)
1839
kind = self._tree.stored_kind(self._tree.id2path(file_id))
1840
parent_trans_id = self.final_parent(trans_id)
1841
parent_file_id = new_path_file_ids.get(parent_trans_id)
1842
if parent_file_id is None:
1843
parent_file_id = self.final_file_id(parent_trans_id)
1844
if trans_id in self._new_reference_revision:
1845
new_entry = inventory.TreeReference(
1847
self._new_name[trans_id],
1848
self.final_file_id(self._new_parent[trans_id]),
1849
None, self._new_reference_revision[trans_id])
1851
new_entry = inventory.make_entry(kind,
1852
self.final_name(trans_id),
1853
parent_file_id, file_id)
1855
old_path = self._tree.id2path(new_entry.file_id)
1856
except errors.NoSuchId:
1858
new_executability = self._new_executability.get(trans_id)
1859
if new_executability is not None:
1860
new_entry.executable = new_executability
1861
inventory_delta.append(
1862
(old_path, path, new_entry.file_id, new_entry))
1863
return inventory_delta
1865
def _apply_removals(self, mover):
1866
"""Perform tree operations that remove directory/inventory names.
1868
That is, delete files that are to be deleted, and put any files that
1869
need renaming into limbo. This must be done in strict child-to-parent
1872
If inventory_delta is None, no inventory delta generation is performed.
1874
tree_paths = sorted(self._tree_path_ids.items(), reverse=True)
1875
with ui.ui_factory.nested_progress_bar() as child_pb:
1876
for num, (path, trans_id) in enumerate(tree_paths):
1877
# do not attempt to move root into a subdirectory of itself.
1880
child_pb.update(gettext('removing file'), num, len(tree_paths))
1881
full_path = self._tree.abspath(path)
1882
if trans_id in self._removed_contents:
1883
delete_path = os.path.join(self._deletiondir, trans_id)
1884
mover.pre_delete(full_path, delete_path)
1885
elif (trans_id in self._new_name or
1886
trans_id in self._new_parent):
1888
mover.rename(full_path, self._limbo_name(trans_id))
1889
except errors.TransformRenameFailed as e:
1890
if e.errno != errno.ENOENT:
1893
self.rename_count += 1
1895
def _apply_insertions(self, mover):
1896
"""Perform tree operations that insert directory/inventory names.
1898
That is, create any files that need to be created, and restore from
1899
limbo any files that needed renaming. This must be done in strict
1900
parent-to-child order.
1902
If inventory_delta is None, no inventory delta is calculated, and
1903
no list of modified paths is returned.
1905
new_paths = self.new_paths(filesystem_only=True)
1907
with ui.ui_factory.nested_progress_bar() as child_pb:
1908
for num, (path, trans_id) in enumerate(new_paths):
1910
child_pb.update(gettext('adding file'),
1911
num, len(new_paths))
1912
full_path = self._tree.abspath(path)
1913
if trans_id in self._needs_rename:
1915
mover.rename(self._limbo_name(trans_id), full_path)
1916
except errors.TransformRenameFailed as e:
1917
# We may be renaming a dangling inventory id
1918
if e.errno != errno.ENOENT:
1921
self.rename_count += 1
1922
# TODO: if trans_id in self._observed_sha1s, we should
1923
# re-stat the final target, since ctime will be
1924
# updated by the change.
1925
if (trans_id in self._new_contents
1926
or self.path_changed(trans_id)):
1927
if trans_id in self._new_contents:
1928
modified_paths.append(full_path)
1929
if trans_id in self._new_executability:
1930
self._set_executability(path, trans_id)
1931
if trans_id in self._observed_sha1s:
1932
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1933
st = osutils.lstat(full_path)
1934
self._observed_sha1s[trans_id] = (o_sha1, st)
1935
for path, trans_id in new_paths:
1936
# new_paths includes stuff like workingtree conflicts. Only the
1937
# stuff in new_contents actually comes from limbo.
1938
if trans_id in self._limbo_files:
1939
del self._limbo_files[trans_id]
1940
self._new_contents.clear()
1941
return modified_paths
1943
def _apply_observed_sha1s(self):
1944
"""After we have finished renaming everything, update observed sha1s
1946
This has to be done after self._tree.apply_inventory_delta, otherwise
1947
it doesn't know anything about the files we are updating. Also, we want
1948
to do this as late as possible, so that most entries end up cached.
1950
# TODO: this doesn't update the stat information for directories. So
1951
# the first 'bzr status' will still need to rewrite
1952
# .bzr/checkout/dirstate. However, we at least don't need to
1953
# re-read all of the files.
1954
# TODO: If the operation took a while, we could do a time.sleep(3) here
1955
# to allow the clock to tick over and ensure we won't have any
1956
# problems. (we could observe start time, and finish time, and if
1957
# it is less than eg 10% overhead, add a sleep call.)
1958
paths = FinalPaths(self)
1959
for trans_id, observed in self._observed_sha1s.items():
1960
path = paths.get_path(trans_id)
1961
self._tree._observed_sha1(path, observed)
1964
class TransformPreview(DiskTreeTransform):
1965
"""A TreeTransform for generating preview trees.
1967
Unlike TreeTransform, this version works when the input tree is a
1968
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1969
unversioned files in the input tree.
1972
def __init__(self, tree, pb=None, case_sensitive=True):
1974
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1975
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1977
def canonical_path(self, path):
1980
def tree_kind(self, trans_id):
1981
path = self._tree_id_paths.get(trans_id)
1984
kind = self._tree.path_content_summary(path)[0]
1985
if kind == 'missing':
1989
def _set_mode(self, trans_id, mode_id, typefunc):
1990
"""Set the mode of new file contents.
1991
The mode_id is the existing file to get the mode from (often the same
1992
as trans_id). The operation is only performed if there's a mode match
1993
according to typefunc.
1995
# is it ok to ignore this? probably
1998
def iter_tree_children(self, parent_id):
1999
"""Iterate through the entry's tree children, if any"""
2001
path = self._tree_id_paths[parent_id]
2005
entry = next(self._tree.iter_entries_by_dir(
2006
specific_files=[path]))[1]
2007
except StopIteration:
2009
children = getattr(entry, 'children', {})
2010
for child in children:
2011
childpath = joinpath(path, child)
2012
yield self.trans_id_tree_path(childpath)
2014
def new_orphan(self, trans_id, parent_id):
2015
raise NotImplementedError(self.new_orphan)
2018
class _PreviewTree(inventorytree.InventoryTree):
2019
"""Partial implementation of Tree to support show_diff_trees"""
2021
def __init__(self, transform):
2022
self._transform = transform
2023
self._final_paths = FinalPaths(transform)
2024
self.__by_parent = None
2025
self._parent_ids = []
2026
self._all_children_cache = {}
2027
self._path2trans_id_cache = {}
2028
self._final_name_cache = {}
2029
self._iter_changes_cache = dict((c.file_id, c) for c in
2030
self._transform.iter_changes())
2032
def supports_tree_reference(self):
2033
# TODO(jelmer): Support tree references in _PreviewTree.
2034
# return self._transform._tree.supports_tree_reference()
2037
def _content_change(self, file_id):
2038
"""Return True if the content of this file changed"""
2039
changes = self._iter_changes_cache.get(file_id)
2040
return (changes is not None and changes.changed_content)
2042
def _get_repository(self):
2043
repo = getattr(self._transform._tree, '_repository', None)
2045
repo = self._transform._tree.branch.repository
2048
def _iter_parent_trees(self):
2049
for revision_id in self.get_parent_ids():
2051
yield self.revision_tree(revision_id)
2052
except errors.NoSuchRevisionInTree:
2053
yield self._get_repository().revision_tree(revision_id)
2055
def _get_file_revision(self, path, file_id, vf, tree_revision):
2057
(file_id, t.get_file_revision(t.id2path(file_id)))
2058
for t in self._iter_parent_trees()]
2059
vf.add_lines((file_id, tree_revision), parent_keys,
2060
self.get_file_lines(path))
2061
repo = self._get_repository()
2062
base_vf = repo.texts
2063
if base_vf not in vf.fallback_versionedfiles:
2064
vf.fallback_versionedfiles.append(base_vf)
2065
return tree_revision
2067
def _stat_limbo_file(self, trans_id):
2068
name = self._transform._limbo_name(trans_id)
2069
return os.lstat(name)
2072
def _by_parent(self):
2073
if self.__by_parent is None:
2074
self.__by_parent = self._transform.by_parent()
2075
return self.__by_parent
2077
def _comparison_data(self, entry, path):
2078
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2079
if kind == 'missing':
2083
file_id = self._transform.final_file_id(self._path2trans_id(path))
2084
executable = self.is_executable(path)
2085
return kind, executable, None
2087
def is_locked(self):
2090
def lock_read(self):
2091
# Perhaps in theory, this should lock the TreeTransform?
2092
return lock.LogicalLockResult(self.unlock)
2098
def root_inventory(self):
2099
"""This Tree does not use inventory as its backing data."""
2100
raise NotImplementedError(_PreviewTree.root_inventory)
2102
def all_file_ids(self):
2103
tree_ids = set(self._transform._tree.all_file_ids())
2104
tree_ids.difference_update(self._transform.tree_file_id(t)
2105
for t in self._transform._removed_id)
2106
tree_ids.update(self._transform._new_id.values())
2109
def all_versioned_paths(self):
2110
tree_paths = set(self._transform._tree.all_versioned_paths())
2112
tree_paths.difference_update(
2113
self._transform.trans_id_tree_path(t)
2114
for t in self._transform._removed_id)
2117
self._final_paths._determine_path(t)
2118
for t in self._transform._new_id)
2122
def _path2trans_id(self, path):
2123
# We must not use None here, because that is a valid value to store.
2124
trans_id = self._path2trans_id_cache.get(path, object)
2125
if trans_id is not object:
2127
segments = splitpath(path)
2128
cur_parent = self._transform.root
2129
for cur_segment in segments:
2130
for child in self._all_children(cur_parent):
2131
final_name = self._final_name_cache.get(child)
2132
if final_name is None:
2133
final_name = self._transform.final_name(child)
2134
self._final_name_cache[child] = final_name
2135
if final_name == cur_segment:
2139
self._path2trans_id_cache[path] = None
2141
self._path2trans_id_cache[path] = cur_parent
2144
def path2id(self, path):
2145
if isinstance(path, list):
2148
path = osutils.pathjoin(*path)
2149
return self._transform.final_file_id(self._path2trans_id(path))
2151
def id2path(self, file_id, recurse='down'):
2152
trans_id = self._transform.trans_id_file_id(file_id)
2154
return self._final_paths._determine_path(trans_id)
2156
raise errors.NoSuchId(self, file_id)
2158
def _all_children(self, trans_id):
2159
children = self._all_children_cache.get(trans_id)
2160
if children is not None:
2162
children = set(self._transform.iter_tree_children(trans_id))
2163
# children in the _new_parent set are provided by _by_parent.
2164
children.difference_update(self._transform._new_parent)
2165
children.update(self._by_parent.get(trans_id, []))
2166
self._all_children_cache[trans_id] = children
2170
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2171
in self._transform._tree.extras())
2172
possible_extras.update(self._transform._new_contents)
2173
possible_extras.update(self._transform._removed_id)
2174
for trans_id in possible_extras:
2175
if self._transform.final_file_id(trans_id) is None:
2176
yield self._final_paths._determine_path(trans_id)
2178
def _make_inv_entries(self, ordered_entries, specific_files=None):
2179
for trans_id, parent_file_id in ordered_entries:
2180
file_id = self._transform.final_file_id(trans_id)
2183
if (specific_files is not None
2184
and self._final_paths.get_path(trans_id) not in specific_files):
2186
kind = self._transform.final_kind(trans_id)
2188
kind = self._transform._tree.stored_kind(
2189
self._transform._tree.id2path(file_id))
2190
new_entry = inventory.make_entry(
2192
self._transform.final_name(trans_id),
2193
parent_file_id, file_id)
2194
yield new_entry, trans_id
2196
def _list_files_by_dir(self):
2197
todo = [ROOT_PARENT]
2199
while len(todo) > 0:
2201
parent_file_id = self._transform.final_file_id(parent)
2202
children = list(self._all_children(parent))
2203
paths = dict(zip(children, self._final_paths.get_paths(children)))
2204
children.sort(key=paths.get)
2205
todo.extend(reversed(children))
2206
for trans_id in children:
2207
ordered_ids.append((trans_id, parent_file_id))
2210
def iter_child_entries(self, path):
2211
trans_id = self._path2trans_id(path)
2212
if trans_id is None:
2213
raise errors.NoSuchFile(path)
2214
todo = [(child_trans_id, trans_id) for child_trans_id in
2215
self._all_children(trans_id)]
2216
for entry, trans_id in self._make_inv_entries(todo):
2219
def iter_entries_by_dir(self, specific_files=None, recurse_nested=False):
2221
raise NotImplementedError(
2222
'follow tree references not yet supported')
2224
# This may not be a maximally efficient implementation, but it is
2225
# reasonably straightforward. An implementation that grafts the
2226
# TreeTransform changes onto the tree's iter_entries_by_dir results
2227
# might be more efficient, but requires tricky inferences about stack
2229
ordered_ids = self._list_files_by_dir()
2230
for entry, trans_id in self._make_inv_entries(ordered_ids,
2232
yield self._final_paths.get_path(trans_id), entry
2234
def _iter_entries_for_dir(self, dir_path):
2235
"""Return path, entry for items in a directory without recursing down."""
2237
dir_trans_id = self._path2trans_id(dir_path)
2238
dir_id = self._transform.final_file_id(dir_trans_id)
2239
for child_trans_id in self._all_children(dir_trans_id):
2240
ordered_ids.append((child_trans_id, dir_id))
2242
for entry, trans_id in self._make_inv_entries(ordered_ids):
2243
path_entries.append((self._final_paths.get_path(trans_id), entry))
2247
def list_files(self, include_root=False, from_dir=None, recursive=True,
2248
recurse_nested=False):
2249
"""See WorkingTree.list_files."""
2251
raise NotImplementedError(
2252
'follow tree references not yet supported')
2254
# XXX This should behave like WorkingTree.list_files, but is really
2255
# more like RevisionTree.list_files.
2261
prefix = from_dir + '/'
2262
entries = self.iter_entries_by_dir()
2263
for path, entry in entries:
2264
if entry.name == '' and not include_root:
2267
if not path.startswith(prefix):
2269
path = path[len(prefix):]
2270
yield path, 'V', entry.kind, entry
2272
if from_dir is None and include_root is True:
2273
root_entry = inventory.make_entry(
2274
'directory', '', ROOT_PARENT, self.path2id(''))
2275
yield '', 'V', 'directory', root_entry
2276
entries = self._iter_entries_for_dir(from_dir or '')
2277
for path, entry in entries:
2278
yield path, 'V', entry.kind, entry
2280
def kind(self, path):
2281
trans_id = self._path2trans_id(path)
2282
if trans_id is None:
2283
raise errors.NoSuchFile(path)
2284
return self._transform.final_kind(trans_id)
2286
def stored_kind(self, path):
2287
trans_id = self._path2trans_id(path)
2288
if trans_id is None:
2289
raise errors.NoSuchFile(path)
2291
return self._transform._new_contents[trans_id]
2293
return self._transform._tree.stored_kind(path)
2295
def get_file_mtime(self, path):
2296
"""See Tree.get_file_mtime"""
2297
file_id = self.path2id(path)
2299
raise errors.NoSuchFile(path)
2300
if not self._content_change(file_id):
2301
return self._transform._tree.get_file_mtime(
2302
self._transform._tree.id2path(file_id))
2303
trans_id = self._path2trans_id(path)
2304
return self._stat_limbo_file(trans_id).st_mtime
2306
def get_file_size(self, path):
2307
"""See Tree.get_file_size"""
2308
trans_id = self._path2trans_id(path)
2309
if trans_id is None:
2310
raise errors.NoSuchFile(path)
2311
kind = self._transform.final_kind(trans_id)
2314
if trans_id in self._transform._new_contents:
2315
return self._stat_limbo_file(trans_id).st_size
2316
if self.kind(path) == 'file':
2317
return self._transform._tree.get_file_size(path)
2321
def get_file_verifier(self, path, stat_value=None):
2322
trans_id = self._path2trans_id(path)
2323
if trans_id is None:
2324
raise errors.NoSuchFile(path)
2325
kind = self._transform._new_contents.get(trans_id)
2327
return self._transform._tree.get_file_verifier(path)
2329
with self.get_file(path) as fileobj:
2330
return ("SHA1", sha_file(fileobj))
2332
def get_file_sha1(self, path, stat_value=None):
2333
trans_id = self._path2trans_id(path)
2334
if trans_id is None:
2335
raise errors.NoSuchFile(path)
2336
kind = self._transform._new_contents.get(trans_id)
2338
return self._transform._tree.get_file_sha1(path)
2340
with self.get_file(path) as fileobj:
2341
return sha_file(fileobj)
2343
def get_reference_revision(self, path):
2344
trans_id = self._path2trans_id(path)
2345
if trans_id is None:
2346
raise errors.NoSuchFile(path)
2347
reference_revision = self._transform._new_reference_revision.get(trans_id)
2348
if reference_revision is None:
2349
return self._transform._tree.get_reference_revision(path)
2350
return reference_revision
2352
def is_executable(self, path):
2353
trans_id = self._path2trans_id(path)
2354
if trans_id is None:
2357
return self._transform._new_executability[trans_id]
2360
return self._transform._tree.is_executable(path)
2361
except OSError as e:
2362
if e.errno == errno.ENOENT:
2365
except errors.NoSuchFile:
2368
def has_filename(self, path):
2369
trans_id = self._path2trans_id(path)
2370
if trans_id in self._transform._new_contents:
2372
elif trans_id in self._transform._removed_contents:
2375
return self._transform._tree.has_filename(path)
2377
def path_content_summary(self, path):
2378
trans_id = self._path2trans_id(path)
2379
tt = self._transform
2380
tree_path = tt._tree_id_paths.get(trans_id)
2381
kind = tt._new_contents.get(trans_id)
2383
if tree_path is None or trans_id in tt._removed_contents:
2384
return 'missing', None, None, None
2385
summary = tt._tree.path_content_summary(tree_path)
2386
kind, size, executable, link_or_sha1 = summary
2389
limbo_name = tt._limbo_name(trans_id)
2390
if trans_id in tt._new_reference_revision:
2391
kind = 'tree-reference'
2393
statval = os.lstat(limbo_name)
2394
size = statval.st_size
2395
if not tt._limbo_supports_executable():
2398
executable = statval.st_mode & S_IEXEC
2402
if kind == 'symlink':
2403
link_or_sha1 = os.readlink(limbo_name)
2404
if not isinstance(link_or_sha1, str):
2405
link_or_sha1 = link_or_sha1.decode(osutils._fs_enc)
2406
executable = tt._new_executability.get(trans_id, executable)
2407
return kind, size, executable, link_or_sha1
2409
def iter_changes(self, from_tree, include_unchanged=False,
2410
specific_files=None, pb=None, extra_trees=None,
2411
require_versioned=True, want_unversioned=False):
2412
"""See InterTree.iter_changes.
2414
This has a fast path that is only used when the from_tree matches
2415
the transform tree, and no fancy options are supplied.
2417
if (from_tree is not self._transform._tree or include_unchanged
2418
or specific_files or want_unversioned):
2419
return tree.InterTree(from_tree, self).iter_changes(
2420
include_unchanged=include_unchanged,
2421
specific_files=specific_files,
2423
extra_trees=extra_trees,
2424
require_versioned=require_versioned,
2425
want_unversioned=want_unversioned)
2426
if want_unversioned:
2427
raise ValueError('want_unversioned is not supported')
2428
return self._transform.iter_changes()
2430
def get_file(self, path):
2431
"""See Tree.get_file"""
2432
file_id = self.path2id(path)
2433
if not self._content_change(file_id):
2434
return self._transform._tree.get_file(path)
2435
trans_id = self._path2trans_id(path)
2436
name = self._transform._limbo_name(trans_id)
2437
return open(name, 'rb')
2439
def get_file_with_stat(self, path):
2440
return self.get_file(path), None
2442
def annotate_iter(self, path,
2443
default_revision=_mod_revision.CURRENT_REVISION):
2444
file_id = self.path2id(path)
2445
changes = self._iter_changes_cache.get(file_id)
2449
changed_content, versioned, kind = (
2450
changes.changed_content, changes.versioned, changes.kind)
2453
get_old = (kind[0] == 'file' and versioned[0])
2455
old_annotation = self._transform._tree.annotate_iter(
2456
path, default_revision=default_revision)
2460
return old_annotation
2461
if not changed_content:
2462
return old_annotation
2463
# TODO: This is doing something similar to what WT.annotate_iter is
2464
# doing, however it fails slightly because it doesn't know what
2465
# the *other* revision_id is, so it doesn't know how to give the
2466
# other as the origin for some lines, they all get
2467
# 'default_revision'
2468
# It would be nice to be able to use the new Annotator based
2469
# approach, as well.
2470
return annotate.reannotate([old_annotation],
2471
self.get_file(path).readlines(),
2474
def get_symlink_target(self, path):
2475
"""See Tree.get_symlink_target"""
2476
file_id = self.path2id(path)
2477
if not self._content_change(file_id):
2478
return self._transform._tree.get_symlink_target(path)
2479
trans_id = self._path2trans_id(path)
2480
name = self._transform._limbo_name(trans_id)
2481
return osutils.readlink(name)
2483
def walkdirs(self, prefix=''):
2484
pending = [self._transform.root]
2485
while len(pending) > 0:
2486
parent_id = pending.pop()
2489
prefix = prefix.rstrip('/')
2490
parent_path = self._final_paths.get_path(parent_id)
2491
parent_file_id = self._transform.final_file_id(parent_id)
2492
for child_id in self._all_children(parent_id):
2493
path_from_root = self._final_paths.get_path(child_id)
2494
basename = self._transform.final_name(child_id)
2495
file_id = self._transform.final_file_id(child_id)
2496
kind = self._transform.final_kind(child_id)
2497
if kind is not None:
2498
versioned_kind = kind
2501
versioned_kind = self._transform._tree.stored_kind(
2502
self._transform._tree.id2path(file_id))
2503
if versioned_kind == 'directory':
2504
subdirs.append(child_id)
2505
children.append((path_from_root, basename, kind, None,
2506
file_id, versioned_kind))
2508
if parent_path.startswith(prefix):
2509
yield (parent_path, parent_file_id), children
2510
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2513
def get_parent_ids(self):
2514
return self._parent_ids
2516
def set_parent_ids(self, parent_ids):
2517
self._parent_ids = parent_ids
2519
def get_revision_tree(self, revision_id):
2520
return self._transform._tree.get_revision_tree(revision_id)
2523
def joinpath(parent, child):
2524
"""Join tree-relative paths, handling the tree root specially"""
2525
if parent is None or parent == "":
2528
return pathjoin(parent, child)
2531
class FinalPaths(object):
2532
"""Make path calculation cheap by memoizing paths.
2534
The underlying tree must not be manipulated between calls, or else
2535
the results will likely be incorrect.
2538
def __init__(self, transform):
2539
object.__init__(self)
2540
self._known_paths = {}
2541
self.transform = transform
2543
def _determine_path(self, trans_id):
2544
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2546
name = self.transform.final_name(trans_id)
2547
parent_id = self.transform.final_parent(trans_id)
2548
if parent_id == self.transform.root:
2551
return pathjoin(self.get_path(parent_id), name)
2553
def get_path(self, trans_id):
2554
"""Find the final path associated with a trans_id"""
2555
if trans_id not in self._known_paths:
2556
self._known_paths[trans_id] = self._determine_path(trans_id)
2557
return self._known_paths[trans_id]
2559
def get_paths(self, trans_ids):
2560
return [(self.get_path(t), t) for t in trans_ids]
2563
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2564
delta_from_tree=False):
2565
"""Create working tree for a branch, using a TreeTransform.
2567
This function should be used on empty trees, having a tree root at most.
2568
(see merge and revert functionality for working with existing trees)
2570
Existing files are handled like so:
2572
- Existing bzrdirs take precedence over creating new items. They are
2573
created as '%s.diverted' % name.
2574
- Otherwise, if the content on disk matches the content we are building,
2575
it is silently replaced.
2576
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2578
:param tree: The tree to convert wt into a copy of
2579
:param wt: The working tree that files will be placed into
2580
:param accelerator_tree: A tree which can be used for retrieving file
2581
contents more quickly than tree itself, i.e. a workingtree. tree
2582
will be used for cases where accelerator_tree's content is different.
2583
:param hardlink: If true, hard-link files to accelerator_tree, where
2584
possible. accelerator_tree must implement abspath, i.e. be a
2586
:param delta_from_tree: If true, build_tree may use the input Tree to
2587
generate the inventory delta.
2589
with contextlib.ExitStack() as exit_stack:
2590
exit_stack.enter_context(wt.lock_tree_write())
2591
exit_stack.enter_context(tree.lock_read())
2592
if accelerator_tree is not None:
2593
exit_stack.enter_context(accelerator_tree.lock_read())
2594
return _build_tree(tree, wt, accelerator_tree, hardlink,
2598
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2599
"""See build_tree."""
2600
for num, _unused in enumerate(wt.all_versioned_paths()):
2601
if num > 0: # more than just a root
2602
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2604
top_pb = ui.ui_factory.nested_progress_bar()
2605
pp = ProgressPhase("Build phase", 2, top_pb)
2606
if tree.path2id('') is not None:
2607
# This is kind of a hack: we should be altering the root
2608
# as part of the regular tree shape diff logic.
2609
# The conditional test here is to avoid doing an
2610
# expensive operation (flush) every time the root id
2611
# is set within the tree, nor setting the root and thus
2612
# marking the tree as dirty, because we use two different
2613
# idioms here: tree interfaces and inventory interfaces.
2614
if wt.path2id('') != tree.path2id(''):
2615
wt.set_root_id(tree.path2id(''))
2617
tt = wt.get_transform()
2621
file_trans_id[wt.path2id('')] = tt.trans_id_tree_path('')
2622
with ui.ui_factory.nested_progress_bar() as pb:
2623
deferred_contents = []
2625
total = len(tree.all_versioned_paths())
2627
precomputed_delta = []
2629
precomputed_delta = None
2630
# Check if tree inventory has content. If so, we populate
2631
# existing_files with the directory content. If there are no
2632
# entries we skip populating existing_files as its not used.
2633
# This improves performance and unncessary work on large
2634
# directory trees. (#501307)
2636
existing_files = set()
2637
for dir, files in wt.walkdirs():
2638
existing_files.update(f[0] for f in files)
2639
for num, (tree_path, entry) in \
2640
enumerate(tree.iter_entries_by_dir()):
2641
pb.update(gettext("Building tree"), num
2642
- len(deferred_contents), total)
2643
if entry.parent_id is None:
2646
file_id = entry.file_id
2648
precomputed_delta.append((None, tree_path, file_id, entry))
2649
if tree_path in existing_files:
2650
target_path = wt.abspath(tree_path)
2651
kind = file_kind(target_path)
2652
if kind == "directory":
2654
controldir.ControlDir.open(target_path)
2655
except errors.NotBranchError:
2659
if (file_id not in divert
2661
tree, entry, tree_path, kind, target_path)):
2662
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2663
if kind == 'directory':
2665
parent_id = file_trans_id[entry.parent_id]
2666
if entry.kind == 'file':
2667
# We *almost* replicate new_by_entry, so that we can defer
2668
# getting the file text, and get them all at once.
2669
trans_id = tt.create_path(entry.name, parent_id)
2670
file_trans_id[file_id] = trans_id
2671
tt.version_file(file_id, trans_id)
2672
executable = tree.is_executable(tree_path)
2674
tt.set_executability(executable, trans_id)
2675
trans_data = (trans_id, file_id,
2676
tree_path, entry.text_sha1)
2677
deferred_contents.append((tree_path, trans_data))
2679
file_trans_id[file_id] = new_by_entry(
2680
tree_path, tt, entry, parent_id, tree)
2682
new_trans_id = file_trans_id[file_id]
2683
old_parent = tt.trans_id_tree_path(tree_path)
2684
_reparent_children(tt, old_parent, new_trans_id)
2685
offset = num + 1 - len(deferred_contents)
2686
_create_files(tt, tree, deferred_contents, pb, offset,
2687
accelerator_tree, hardlink)
2689
divert_trans = set(file_trans_id[f] for f in divert)
2692
return resolve_checkout(t, c, divert_trans)
2693
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2694
if len(raw_conflicts) > 0:
2695
precomputed_delta = None
2696
conflicts = cook_conflicts(raw_conflicts, tt)
2697
for conflict in conflicts:
2698
trace.warning(str(conflict))
2700
wt.add_conflicts(conflicts)
2701
except errors.UnsupportedOperation:
2703
result = tt.apply(no_conflicts=True,
2704
precomputed_delta=precomputed_delta)
2711
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2713
total = len(desired_files) + offset
2715
if accelerator_tree is None:
2716
new_desired_files = desired_files
2718
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2720
change.path for change in iter
2721
if not (change.changed_content or change.executable[0] != change.executable[1])]
2722
if accelerator_tree.supports_content_filtering():
2723
unchanged = [(tp, ap) for (tp, ap) in unchanged
2724
if not next(accelerator_tree.iter_search_rules([ap]))]
2725
unchanged = dict(unchanged)
2726
new_desired_files = []
2728
for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
2729
accelerator_path = unchanged.get(tree_path)
2730
if accelerator_path is None:
2731
new_desired_files.append((tree_path,
2732
(trans_id, file_id, tree_path, text_sha1)))
2734
pb.update(gettext('Adding file contents'), count + offset, total)
2736
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2739
with accelerator_tree.get_file(accelerator_path) as f:
2740
chunks = osutils.file_iterator(f)
2741
if wt.supports_content_filtering():
2742
filters = wt._content_filter_stack(tree_path)
2743
chunks = filtered_output_bytes(chunks, filters,
2744
ContentFilterContext(tree_path, tree))
2745
tt.create_file(chunks, trans_id, sha1=text_sha1)
2748
for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
2749
tree.iter_files_bytes(new_desired_files)):
2750
if wt.supports_content_filtering():
2751
filters = wt._content_filter_stack(tree_path)
2752
contents = filtered_output_bytes(contents, filters,
2753
ContentFilterContext(tree_path, tree))
2754
tt.create_file(contents, trans_id, sha1=text_sha1)
2755
pb.update(gettext('Adding file contents'), count + offset, total)
2758
def _reparent_children(tt, old_parent, new_parent):
2759
for child in tt.iter_tree_children(old_parent):
2760
tt.adjust_path(tt.final_name(child), new_parent, child)
2763
def _reparent_transform_children(tt, old_parent, new_parent):
2764
by_parent = tt.by_parent()
2765
for child in by_parent[old_parent]:
2766
tt.adjust_path(tt.final_name(child), new_parent, child)
2767
return by_parent[old_parent]
2770
def _content_match(tree, entry, tree_path, kind, target_path):
2771
if entry.kind != kind:
2773
if entry.kind == "directory":
2775
if entry.kind == "file":
2776
with open(target_path, 'rb') as f1, \
2777
tree.get_file(tree_path) as f2:
2778
if osutils.compare_files(f1, f2):
2780
elif entry.kind == "symlink":
2781
if tree.get_symlink_target(tree_path) == os.readlink(target_path):
2786
def resolve_checkout(tt, conflicts, divert):
2787
new_conflicts = set()
2788
for c_type, conflict in ((c[0], c) for c in conflicts):
2789
# Anything but a 'duplicate' would indicate programmer error
2790
if c_type != 'duplicate':
2791
raise AssertionError(c_type)
2792
# Now figure out which is new and which is old
2793
if tt.new_contents(conflict[1]):
2794
new_file = conflict[1]
2795
old_file = conflict[2]
2797
new_file = conflict[2]
2798
old_file = conflict[1]
2800
# We should only get here if the conflict wasn't completely
2802
final_parent = tt.final_parent(old_file)
2803
if new_file in divert:
2804
new_name = tt.final_name(old_file) + '.diverted'
2805
tt.adjust_path(new_name, final_parent, new_file)
2806
new_conflicts.add((c_type, 'Diverted to',
2807
new_file, old_file))
2809
new_name = tt.final_name(old_file) + '.moved'
2810
tt.adjust_path(new_name, final_parent, old_file)
2811
new_conflicts.add((c_type, 'Moved existing file to',
2812
old_file, new_file))
2813
return new_conflicts
2816
def new_by_entry(path, tt, entry, parent_id, tree):
2817
"""Create a new file according to its inventory entry"""
2821
with tree.get_file(path) as f:
2822
executable = tree.is_executable(path)
2824
name, parent_id, osutils.file_iterator(f), entry.file_id,
2826
elif kind in ('directory', 'tree-reference'):
2827
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2828
if kind == 'tree-reference':
2829
tt.set_tree_reference(entry.reference_revision, trans_id)
2831
elif kind == 'symlink':
2832
target = tree.get_symlink_target(path)
2833
return tt.new_symlink(name, parent_id, target, entry.file_id)
2835
raise errors.BadFileKindError(name, kind)
2838
def create_from_tree(tt, trans_id, tree, path, chunks=None,
2839
filter_tree_path=None):
2840
"""Create new file contents according to tree contents.
2842
:param filter_tree_path: the tree path to use to lookup
2843
content filters to apply to the bytes output in the working tree.
2844
This only applies if the working tree supports content filtering.
2846
kind = tree.kind(path)
2847
if kind == 'directory':
2848
tt.create_directory(trans_id)
2849
elif kind == "file":
2851
f = tree.get_file(path)
2852
chunks = osutils.file_iterator(f)
2857
if wt.supports_content_filtering() and filter_tree_path is not None:
2858
filters = wt._content_filter_stack(filter_tree_path)
2859
chunks = filtered_output_bytes(
2861
ContentFilterContext(filter_tree_path, tree))
2862
tt.create_file(chunks, trans_id)
2866
elif kind == "symlink":
2867
tt.create_symlink(tree.get_symlink_target(path), trans_id)
2869
raise AssertionError('Unknown kind %r' % kind)
2872
def create_entry_executability(tt, entry, trans_id):
2873
"""Set the executability of a trans_id according to an inventory entry"""
2874
if entry.kind == "file":
2875
tt.set_executability(entry.executable, trans_id)
2878
def revert(working_tree, target_tree, filenames, backups=False,
2879
pb=None, change_reporter=None):
2880
"""Revert a working tree's contents to those of a target tree."""
2881
pb = ui.ui_factory.nested_progress_bar()
2883
with target_tree.lock_read(), working_tree.get_transform(pb) as tt:
2884
pp = ProgressPhase("Revert phase", 3, pb)
2885
conflicts, merge_modified = _prepare_revert_transform(
2886
working_tree, target_tree, tt, filenames, backups, pp)
2888
change_reporter = delta._ChangeReporter(
2889
unversioned_filter=working_tree.is_ignored)
2890
delta.report_changes(tt.iter_changes(), change_reporter)
2891
for conflict in conflicts:
2892
trace.warning(str(conflict))
2895
if working_tree.supports_merge_modified():
2896
working_tree.set_merge_modified(merge_modified)
2902
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2903
backups, pp, basis_tree=None,
2904
merge_modified=None):
2905
with ui.ui_factory.nested_progress_bar() as child_pb:
2906
if merge_modified is None:
2907
merge_modified = working_tree.merge_modified()
2908
merge_modified = _alter_files(working_tree, target_tree, tt,
2909
child_pb, filenames, backups,
2910
merge_modified, basis_tree)
2911
with ui.ui_factory.nested_progress_bar() as child_pb:
2912
raw_conflicts = resolve_conflicts(
2913
tt, child_pb, lambda t, c: conflict_pass(t, c, target_tree))
2914
conflicts = cook_conflicts(raw_conflicts, tt)
2915
return conflicts, merge_modified
2918
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2919
backups, merge_modified, basis_tree=None):
2920
if basis_tree is not None:
2921
basis_tree.lock_read()
2922
# We ask the working_tree for its changes relative to the target, rather
2923
# than the target changes relative to the working tree. Because WT4 has an
2924
# optimizer to compare itself to a target, but no optimizer for the
2926
change_list = working_tree.iter_changes(
2927
target_tree, specific_files=specific_files, pb=pb)
2928
if not target_tree.is_versioned(u''):
2934
for id_num, change in enumerate(change_list):
2935
file_id = change.file_id
2936
target_path, wt_path = change.path
2937
target_versioned, wt_versioned = change.versioned
2938
target_parent, wt_parent = change.parent_id
2939
target_name, wt_name = change.name
2940
target_kind, wt_kind = change.kind
2941
target_executable, wt_executable = change.executable
2942
if skip_root and wt_parent is None:
2944
trans_id = tt.trans_id_file_id(file_id)
2946
if change.changed_content:
2947
keep_content = False
2948
if wt_kind == 'file' and (backups or target_kind is None):
2949
wt_sha1 = working_tree.get_file_sha1(wt_path)
2950
if merge_modified.get(wt_path) != wt_sha1:
2951
# acquire the basis tree lazily to prevent the
2952
# expense of accessing it when it's not needed ?
2953
# (Guessing, RBC, 200702)
2954
if basis_tree is None:
2955
basis_tree = working_tree.basis_tree()
2956
basis_tree.lock_read()
2957
basis_inter = InterTree.get(basis_tree, working_tree)
2958
basis_path = basis_inter.find_source_path(wt_path)
2959
if basis_path is None:
2960
if target_kind is None and not target_versioned:
2963
if wt_sha1 != basis_tree.get_file_sha1(basis_path):
2965
if wt_kind is not None:
2966
if not keep_content:
2967
tt.delete_contents(trans_id)
2968
elif target_kind is not None:
2969
parent_trans_id = tt.trans_id_file_id(wt_parent)
2970
backup_name = tt._available_backup_name(
2971
wt_name, parent_trans_id)
2972
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2973
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2974
if wt_versioned and target_versioned:
2975
tt.unversion_file(trans_id)
2976
tt.version_file(file_id, new_trans_id)
2977
# New contents should have the same unix perms as old
2980
trans_id = new_trans_id
2981
if target_kind in ('directory', 'tree-reference'):
2982
tt.create_directory(trans_id)
2983
if target_kind == 'tree-reference':
2984
revision = target_tree.get_reference_revision(
2986
tt.set_tree_reference(revision, trans_id)
2987
elif target_kind == 'symlink':
2988
tt.create_symlink(target_tree.get_symlink_target(
2989
target_path), trans_id)
2990
elif target_kind == 'file':
2991
deferred_files.append(
2992
(target_path, (trans_id, mode_id, file_id)))
2993
if basis_tree is None:
2994
basis_tree = working_tree.basis_tree()
2995
basis_tree.lock_read()
2996
new_sha1 = target_tree.get_file_sha1(target_path)
2997
basis_inter = InterTree.get(basis_tree, target_tree)
2998
basis_path = basis_inter.find_source_path(target_path)
2999
if (basis_path is not None and
3000
new_sha1 == basis_tree.get_file_sha1(basis_path)):
3001
# If the new contents of the file match what is in basis,
3002
# then there is no need to store in merge_modified.
3003
if basis_path in merge_modified:
3004
del merge_modified[basis_path]
3006
merge_modified[target_path] = new_sha1
3008
# preserve the execute bit when backing up
3009
if keep_content and wt_executable == target_executable:
3010
tt.set_executability(target_executable, trans_id)
3011
elif target_kind is not None:
3012
raise AssertionError(target_kind)
3013
if not wt_versioned and target_versioned:
3014
tt.version_file(file_id, trans_id)
3015
if wt_versioned and not target_versioned:
3016
tt.unversion_file(trans_id)
3017
if (target_name is not None
3018
and (wt_name != target_name or wt_parent != target_parent)):
3019
if target_name == '' and target_parent is None:
3020
parent_trans = ROOT_PARENT
3022
parent_trans = tt.trans_id_file_id(target_parent)
3023
if wt_parent is None and wt_versioned:
3024
tt.adjust_root_path(target_name, parent_trans)
3026
tt.adjust_path(target_name, parent_trans, trans_id)
3027
if wt_executable != target_executable and target_kind == "file":
3028
tt.set_executability(target_executable, trans_id)
3029
if working_tree.supports_content_filtering():
3030
for (trans_id, mode_id, file_id), bytes in (
3031
target_tree.iter_files_bytes(deferred_files)):
3032
# We're reverting a tree to the target tree so using the
3033
# target tree to find the file path seems the best choice
3034
# here IMO - Ian C 27/Oct/2009
3035
filter_tree_path = target_tree.id2path(file_id)
3036
filters = working_tree._content_filter_stack(filter_tree_path)
3037
bytes = filtered_output_bytes(
3039
ContentFilterContext(filter_tree_path, working_tree))
3040
tt.create_file(bytes, trans_id, mode_id)
3042
for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
3044
tt.create_file(bytes, trans_id, mode_id)
3045
tt.fixup_new_roots()
3047
if basis_tree is not None:
3049
return merge_modified
3052
def resolve_conflicts(tt, pb=None, pass_func=None):
3053
"""Make many conflict-resolution attempts, but die if they fail"""
3054
if pass_func is None:
3055
pass_func = conflict_pass
3056
new_conflicts = set()
3057
with ui.ui_factory.nested_progress_bar() as pb:
3059
pb.update(gettext('Resolution pass'), n + 1, 10)
3060
conflicts = tt.find_conflicts()
3061
if len(conflicts) == 0:
3062
return new_conflicts
3063
new_conflicts.update(pass_func(tt, conflicts))
3064
raise MalformedTransform(conflicts=conflicts)
3067
def conflict_pass(tt, conflicts, path_tree=None):
3068
"""Resolve some classes of conflicts.
3070
:param tt: The transform to resolve conflicts in
3071
:param conflicts: The conflicts to resolve
3072
:param path_tree: A Tree to get supplemental paths from
3074
new_conflicts = set()
3075
for c_type, conflict in ((c[0], c) for c in conflicts):
3076
if c_type == 'duplicate id':
3077
tt.unversion_file(conflict[1])
3078
new_conflicts.add((c_type, 'Unversioned existing file',
3079
conflict[1], conflict[2], ))
3080
elif c_type == 'duplicate':
3081
# files that were renamed take precedence
3082
final_parent = tt.final_parent(conflict[1])
3083
if tt.path_changed(conflict[1]):
3084
existing_file, new_file = conflict[2], conflict[1]
3086
existing_file, new_file = conflict[1], conflict[2]
3087
new_name = tt.final_name(existing_file) + '.moved'
3088
tt.adjust_path(new_name, final_parent, existing_file)
3089
new_conflicts.add((c_type, 'Moved existing file to',
3090
existing_file, new_file))
3091
elif c_type == 'parent loop':
3092
# break the loop by undoing one of the ops that caused the loop
3094
while not tt.path_changed(cur):
3095
cur = tt.final_parent(cur)
3096
new_conflicts.add((c_type, 'Cancelled move', cur,
3097
tt.final_parent(cur),))
3098
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3100
elif c_type == 'missing parent':
3101
trans_id = conflict[1]
3102
if trans_id in tt._removed_contents:
3103
cancel_deletion = True
3104
orphans = tt._get_potential_orphans(trans_id)
3106
cancel_deletion = False
3107
# All children are orphans
3110
tt.new_orphan(o, trans_id)
3111
except OrphaningError:
3112
# Something bad happened so we cancel the directory
3113
# deletion which will leave it in place with a
3114
# conflict. The user can deal with it from there.
3115
# Note that this also catch the case where we don't
3116
# want to create orphans and leave the directory in
3118
cancel_deletion = True
3121
# Cancel the directory deletion
3122
tt.cancel_deletion(trans_id)
3123
new_conflicts.add(('deleting parent', 'Not deleting',
3128
tt.final_name(trans_id)
3130
if path_tree is not None:
3131
file_id = tt.final_file_id(trans_id)
3133
file_id = tt.inactive_file_id(trans_id)
3134
_, entry = next(path_tree.iter_entries_by_dir(
3135
specific_files=[path_tree.id2path(file_id)]))
3136
# special-case the other tree root (move its
3137
# children to current root)
3138
if entry.parent_id is None:
3140
moved = _reparent_transform_children(
3141
tt, trans_id, tt.root)
3143
new_conflicts.add((c_type, 'Moved to root',
3146
parent_trans_id = tt.trans_id_file_id(
3148
tt.adjust_path(entry.name, parent_trans_id,
3151
tt.create_directory(trans_id)
3152
new_conflicts.add((c_type, 'Created directory', trans_id))
3153
elif c_type == 'unversioned parent':
3154
file_id = tt.inactive_file_id(conflict[1])
3155
# special-case the other tree root (move its children instead)
3156
if path_tree and path_tree.path2id('') == file_id:
3157
# This is the root entry, skip it
3159
tt.version_file(file_id, conflict[1])
3160
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3161
elif c_type == 'non-directory parent':
3162
parent_id = conflict[1]
3163
parent_parent = tt.final_parent(parent_id)
3164
parent_name = tt.final_name(parent_id)
3165
parent_file_id = tt.final_file_id(parent_id)
3166
new_parent_id = tt.new_directory(parent_name + '.new',
3167
parent_parent, parent_file_id)
3168
_reparent_transform_children(tt, parent_id, new_parent_id)
3169
if parent_file_id is not None:
3170
tt.unversion_file(parent_id)
3171
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3172
elif c_type == 'versioning no contents':
3173
tt.cancel_versioning(conflict[1])
3174
return new_conflicts
3177
def cook_conflicts(raw_conflicts, tt):
3178
"""Generate a list of cooked conflicts, sorted by file path"""
3179
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3180
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3183
def iter_cook_conflicts(raw_conflicts, tt):
3185
for conflict in raw_conflicts:
3186
c_type = conflict[0]
3187
action = conflict[1]
3188
modified_path = fp.get_path(conflict[2])
3189
modified_id = tt.final_file_id(conflict[2])
3190
if len(conflict) == 3:
3191
yield conflicts.Conflict.factory(
3192
c_type, action=action, path=modified_path, file_id=modified_id)
3195
conflicting_path = fp.get_path(conflict[3])
3196
conflicting_id = tt.final_file_id(conflict[3])
3197
yield conflicts.Conflict.factory(
3198
c_type, action=action, path=modified_path,
3199
file_id=modified_id,
3200
conflict_path=conflicting_path,
3201
conflict_file_id=conflicting_id)
3204
class _FileMover(object):
3205
"""Moves and deletes files for TreeTransform, tracking operations"""
3208
self.past_renames = []
3209
self.pending_deletions = []
3211
def rename(self, from_, to):
3212
"""Rename a file from one path to another."""
3214
os.rename(from_, to)
3215
except OSError as e:
3216
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3217
raise errors.FileExists(to, str(e))
3218
# normal OSError doesn't include filenames so it's hard to see where
3219
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3220
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3221
self.past_renames.append((from_, to))
3223
def pre_delete(self, from_, to):
3224
"""Rename a file out of the way and mark it for deletion.
3226
Unlike os.unlink, this works equally well for files and directories.
3227
:param from_: The current file path
3228
:param to: A temporary path for the file
3230
self.rename(from_, to)
3231
self.pending_deletions.append(to)
3234
"""Reverse all renames that have been performed"""
3235
for from_, to in reversed(self.past_renames):
3237
os.rename(to, from_)
3238
except OSError as e:
3239
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3240
# after rollback, don't reuse _FileMover
3241
self.past_renames = None
3242
self.pending_deletions = None
3244
def apply_deletions(self):
3245
"""Apply all marked deletions"""
3246
for path in self.pending_deletions:
3248
# after apply_deletions, don't reuse _FileMover
3249
self.past_renames = None
3250
self.pending_deletions = None
3253
def link_tree(target_tree, source_tree):
3254
"""Where possible, hard-link files in a tree to those in another tree.
3256
:param target_tree: Tree to change
3257
:param source_tree: Tree to hard-link from
3259
with target_tree.get_transform() as tt:
3260
for change in target_tree.iter_changes(source_tree, include_unchanged=True):
3261
if change.changed_content:
3263
if change.kind != ('file', 'file'):
3265
if change.executable[0] != change.executable[1]:
3267
trans_id = tt.trans_id_tree_path(change.path[1])
3268
tt.delete_contents(trans_id)
3269
tt.create_hardlink(source_tree.abspath(change.path[0]), trans_id)
added
removed
breezy/transform.py
