1
# Copyright (C) 2006-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from stat import S_ISREG, S_IEXEC
25
config as _mod_config,
32
lazy_import.lazy_import(globals(), """
44
revision as _mod_revision,
48
from breezy.bzr import (
52
from breezy.i18n import gettext
54
from .errors import (DuplicateKey, MalformedTransform,
55
ReusingTransform, CantMoveRoot,
56
ImmortalLimbo, NoFinalPath)
57
from .filters import filtered_output_bytes, ContentFilterContext
58
from .mutabletree import MutableTree
59
from .osutils import (
67
from .progress import ProgressPhase
79
ROOT_PARENT = "root-parent"
82
def unique_add(map, key, value):
84
raise DuplicateKey(key=key)
88
class _TransformResults(object):
89
def __init__(self, modified_paths, rename_count):
91
self.modified_paths = modified_paths
92
self.rename_count = rename_count
95
class TreeTransformBase(object):
96
"""The base class for TreeTransform and its kin."""
98
def __init__(self, tree, pb=None, case_sensitive=True):
101
:param tree: The tree that will be transformed, but not necessarily
104
:param case_sensitive: If True, the target of the transform is
105
case sensitive, not just case preserving.
107
object.__init__(self)
110
# mapping of trans_id -> new basename
112
# mapping of trans_id -> new parent trans_id
113
self._new_parent = {}
114
# mapping of trans_id with new contents -> new file_kind
115
self._new_contents = {}
116
# mapping of trans_id => (sha1 of content, stat_value)
117
self._observed_sha1s = {}
118
# Set of trans_ids whose contents will be removed
119
self._removed_contents = set()
120
# Mapping of trans_id -> new execute-bit value
121
self._new_executability = {}
122
# Mapping of trans_id -> new tree-reference value
123
self._new_reference_revision = {}
124
# Mapping of trans_id -> new file_id
126
# Mapping of old file-id -> trans_id
127
self._non_present_ids = {}
128
# Mapping of new file_id -> trans_id
130
# Set of trans_ids that will be removed
131
self._removed_id = set()
132
# Mapping of path in old tree -> trans_id
133
self._tree_path_ids = {}
134
# Mapping trans_id -> path in old tree
135
self._tree_id_paths = {}
136
# The trans_id that will be used as the tree root
137
if tree.is_versioned(''):
138
self._new_root = self.trans_id_tree_path('')
140
self._new_root = None
141
# Indicator of whether the transform has been applied
145
# Whether the target is case sensitive
146
self._case_sensitive_target = case_sensitive
147
# A counter of how many files have been renamed
148
self.rename_count = 0
151
"""Support Context Manager API."""
154
def __exit__(self, exc_type, exc_val, exc_tb):
155
"""Support Context Manager API."""
159
"""Release the working tree lock, if held.
161
This is required if apply has not been invoked, but can be invoked
164
if self._tree is None:
166
for hook in MutableTree.hooks['post_transform']:
167
hook(self._tree, self)
171
def __get_root(self):
172
return self._new_root
174
root = property(__get_root)
176
def _assign_id(self):
177
"""Produce a new tranform id"""
178
new_id = "new-%s" % self._id_number
182
def create_path(self, name, parent):
183
"""Assign a transaction id to a new path"""
184
trans_id = self._assign_id()
185
unique_add(self._new_name, trans_id, name)
186
unique_add(self._new_parent, trans_id, parent)
189
def adjust_path(self, name, parent, trans_id):
190
"""Change the path that is assigned to a transaction id."""
192
raise ValueError("Parent trans-id may not be None")
193
if trans_id == self._new_root:
195
self._new_name[trans_id] = name
196
self._new_parent[trans_id] = parent
198
def adjust_root_path(self, name, parent):
199
"""Emulate moving the root by moving all children, instead.
201
We do this by undoing the association of root's transaction id with the
202
current tree. This allows us to create a new directory with that
203
transaction id. We unversion the root directory and version the
204
physically new directory, and hope someone versions the tree root
207
old_root = self._new_root
208
old_root_file_id = self.final_file_id(old_root)
209
# force moving all children of root
210
for child_id in self.iter_tree_children(old_root):
211
if child_id != parent:
212
self.adjust_path(self.final_name(child_id),
213
self.final_parent(child_id), child_id)
214
file_id = self.final_file_id(child_id)
215
if file_id is not None:
216
self.unversion_file(child_id)
217
self.version_file(file_id, child_id)
219
# the physical root needs a new transaction id
220
self._tree_path_ids.pop("")
221
self._tree_id_paths.pop(old_root)
222
self._new_root = self.trans_id_tree_path('')
223
if parent == old_root:
224
parent = self._new_root
225
self.adjust_path(name, parent, old_root)
226
self.create_directory(old_root)
227
self.version_file(old_root_file_id, old_root)
228
self.unversion_file(self._new_root)
230
def fixup_new_roots(self):
231
"""Reinterpret requests to change the root directory
233
Instead of creating a root directory, or moving an existing directory,
234
all the attributes and children of the new root are applied to the
235
existing root directory.
237
This means that the old root trans-id becomes obsolete, so it is
238
recommended only to invoke this after the root trans-id has become
242
new_roots = [k for k, v in viewitems(self._new_parent)
244
if len(new_roots) < 1:
246
if len(new_roots) != 1:
247
raise ValueError('A tree cannot have two roots!')
248
if self._new_root is None:
249
self._new_root = new_roots[0]
251
old_new_root = new_roots[0]
252
# unversion the new root's directory.
253
if self.final_kind(self._new_root) is None:
254
file_id = self.final_file_id(old_new_root)
256
file_id = self.final_file_id(self._new_root)
257
if old_new_root in self._new_id:
258
self.cancel_versioning(old_new_root)
260
self.unversion_file(old_new_root)
261
# if, at this stage, root still has an old file_id, zap it so we can
262
# stick a new one in.
263
if (self.tree_file_id(self._new_root) is not None
264
and self._new_root not in self._removed_id):
265
self.unversion_file(self._new_root)
266
if file_id is not None:
267
self.version_file(file_id, self._new_root)
269
# Now move children of new root into old root directory.
270
# Ensure all children are registered with the transaction, but don't
271
# use directly-- some tree children have new parents
272
list(self.iter_tree_children(old_new_root))
273
# Move all children of new root into old root directory.
274
for child in self.by_parent().get(old_new_root, []):
275
self.adjust_path(self.final_name(child), self._new_root, child)
277
# Ensure old_new_root has no directory.
278
if old_new_root in self._new_contents:
279
self.cancel_creation(old_new_root)
281
self.delete_contents(old_new_root)
283
# prevent deletion of root directory.
284
if self._new_root in self._removed_contents:
285
self.cancel_deletion(self._new_root)
287
# destroy path info for old_new_root.
288
del self._new_parent[old_new_root]
289
del self._new_name[old_new_root]
291
def trans_id_file_id(self, file_id):
292
"""Determine or set the transaction id associated with a file ID.
293
A new id is only created for file_ids that were never present. If
294
a transaction has been unversioned, it is deliberately still returned.
295
(this will likely lead to an unversioned parent conflict.)
298
raise ValueError('None is not a valid file id')
299
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
300
return self._r_new_id[file_id]
303
path = self._tree.id2path(file_id)
304
except errors.NoSuchId:
305
if file_id in self._non_present_ids:
306
return self._non_present_ids[file_id]
308
trans_id = self._assign_id()
309
self._non_present_ids[file_id] = trans_id
312
return self.trans_id_tree_path(path)
314
def trans_id_tree_path(self, path):
315
"""Determine (and maybe set) the transaction ID for a tree path."""
316
path = self.canonical_path(path)
317
if path not in self._tree_path_ids:
318
self._tree_path_ids[path] = self._assign_id()
319
self._tree_id_paths[self._tree_path_ids[path]] = path
320
return self._tree_path_ids[path]
322
def get_tree_parent(self, trans_id):
323
"""Determine id of the parent in the tree."""
324
path = self._tree_id_paths[trans_id]
327
return self.trans_id_tree_path(os.path.dirname(path))
329
def delete_contents(self, trans_id):
330
"""Schedule the contents of a path entry for deletion"""
331
kind = self.tree_kind(trans_id)
333
self._removed_contents.add(trans_id)
335
def cancel_deletion(self, trans_id):
336
"""Cancel a scheduled deletion"""
337
self._removed_contents.remove(trans_id)
339
def unversion_file(self, trans_id):
340
"""Schedule a path entry to become unversioned"""
341
self._removed_id.add(trans_id)
343
def delete_versioned(self, trans_id):
344
"""Delete and unversion a versioned file"""
345
self.delete_contents(trans_id)
346
self.unversion_file(trans_id)
348
def set_executability(self, executability, trans_id):
349
"""Schedule setting of the 'execute' bit
350
To unschedule, set to None
352
if executability is None:
353
del self._new_executability[trans_id]
355
unique_add(self._new_executability, trans_id, executability)
357
def set_tree_reference(self, revision_id, trans_id):
358
"""Set the reference associated with a directory"""
359
unique_add(self._new_reference_revision, trans_id, revision_id)
361
def version_file(self, file_id, trans_id):
362
"""Schedule a file to become versioned."""
365
unique_add(self._new_id, trans_id, file_id)
366
unique_add(self._r_new_id, file_id, trans_id)
368
def cancel_versioning(self, trans_id):
369
"""Undo a previous versioning of a file"""
370
file_id = self._new_id[trans_id]
371
del self._new_id[trans_id]
372
del self._r_new_id[file_id]
374
def new_paths(self, filesystem_only=False):
375
"""Determine the paths of all new and changed files.
377
:param filesystem_only: if True, only calculate values for files
378
that require renames or execute bit changes.
382
stale_ids = self._needs_rename.difference(self._new_name)
383
stale_ids.difference_update(self._new_parent)
384
stale_ids.difference_update(self._new_contents)
385
stale_ids.difference_update(self._new_id)
386
needs_rename = self._needs_rename.difference(stale_ids)
387
id_sets = (needs_rename, self._new_executability)
389
id_sets = (self._new_name, self._new_parent, self._new_contents,
390
self._new_id, self._new_executability)
391
for id_set in id_sets:
392
new_ids.update(id_set)
393
return sorted(FinalPaths(self).get_paths(new_ids))
395
def _inventory_altered(self):
396
"""Determine which trans_ids need new Inventory entries.
398
An new entry is needed when anything that would be reflected by an
399
inventory entry changes, including file name, file_id, parent file_id,
400
file kind, and the execute bit.
402
Some care is taken to return entries with real changes, not cases
403
where the value is deleted and then restored to its original value,
404
but some actually unchanged values may be returned.
406
:returns: A list of (path, trans_id) for all items requiring an
407
inventory change. Ordered by path.
410
# Find entries whose file_ids are new (or changed).
411
new_file_id = set(t for t in self._new_id
412
if self._new_id[t] != self.tree_file_id(t))
413
for id_set in [self._new_name, self._new_parent, new_file_id,
414
self._new_executability]:
415
changed_ids.update(id_set)
416
# removing implies a kind change
417
changed_kind = set(self._removed_contents)
419
changed_kind.intersection_update(self._new_contents)
420
# Ignore entries that are already known to have changed.
421
changed_kind.difference_update(changed_ids)
422
# to keep only the truly changed ones
423
changed_kind = (t for t in changed_kind
424
if self.tree_kind(t) != self.final_kind(t))
425
# all kind changes will alter the inventory
426
changed_ids.update(changed_kind)
427
# To find entries with changed parent_ids, find parents which existed,
428
# but changed file_id.
429
# Now add all their children to the set.
430
for parent_trans_id in new_file_id:
431
changed_ids.update(self.iter_tree_children(parent_trans_id))
432
return sorted(FinalPaths(self).get_paths(changed_ids))
434
def final_kind(self, trans_id):
435
"""Determine the final file kind, after any changes applied.
437
:return: None if the file does not exist/has no contents. (It is
438
conceivable that a path would be created without the corresponding
439
contents insertion command)
441
if trans_id in self._new_contents:
442
return self._new_contents[trans_id]
443
elif trans_id in self._removed_contents:
446
return self.tree_kind(trans_id)
448
def tree_path(self, trans_id):
449
"""Determine the tree path associated with the trans_id."""
450
return self._tree_id_paths.get(trans_id)
452
def tree_file_id(self, trans_id):
453
"""Determine the file id associated with the trans_id in the tree"""
454
path = self.tree_path(trans_id)
457
# the file is old; the old id is still valid
458
if self._new_root == trans_id:
459
return self._tree.path2id('')
460
return self._tree.path2id(path)
462
def final_file_id(self, trans_id):
463
"""Determine the file id after any changes are applied, or None.
465
None indicates that the file will not be versioned after changes are
469
return self._new_id[trans_id]
471
if trans_id in self._removed_id:
473
return self.tree_file_id(trans_id)
475
def inactive_file_id(self, trans_id):
476
"""Return the inactive file_id associated with a transaction id.
477
That is, the one in the tree or in non_present_ids.
478
The file_id may actually be active, too.
480
file_id = self.tree_file_id(trans_id)
481
if file_id is not None:
483
for key, value in viewitems(self._non_present_ids):
484
if value == trans_id:
487
def final_parent(self, trans_id):
488
"""Determine the parent file_id, after any changes are applied.
490
ROOT_PARENT is returned for the tree root.
493
return self._new_parent[trans_id]
495
return self.get_tree_parent(trans_id)
497
def final_name(self, trans_id):
498
"""Determine the final filename, after all changes are applied."""
500
return self._new_name[trans_id]
503
return os.path.basename(self._tree_id_paths[trans_id])
505
raise NoFinalPath(trans_id, self)
508
"""Return a map of parent: children for known parents.
510
Only new paths and parents of tree files with assigned ids are used.
513
items = list(viewitems(self._new_parent))
514
items.extend((t, self.final_parent(t))
515
for t in list(self._tree_id_paths))
516
for trans_id, parent_id in items:
517
if parent_id not in by_parent:
518
by_parent[parent_id] = set()
519
by_parent[parent_id].add(trans_id)
522
def path_changed(self, trans_id):
523
"""Return True if a trans_id's path has changed."""
524
return (trans_id in self._new_name) or (trans_id in self._new_parent)
526
def new_contents(self, trans_id):
527
return (trans_id in self._new_contents)
529
def find_conflicts(self):
530
"""Find any violations of inventory or filesystem invariants"""
531
if self._done is True:
532
raise ReusingTransform()
534
# ensure all children of all existent parents are known
535
# all children of non-existent parents are known, by definition.
536
self._add_tree_children()
537
by_parent = self.by_parent()
538
conflicts.extend(self._unversioned_parents(by_parent))
539
conflicts.extend(self._parent_loops())
540
conflicts.extend(self._duplicate_entries(by_parent))
541
conflicts.extend(self._duplicate_ids())
542
conflicts.extend(self._parent_type_conflicts(by_parent))
543
conflicts.extend(self._improper_versioning())
544
conflicts.extend(self._executability_conflicts())
545
conflicts.extend(self._overwrite_conflicts())
548
def _check_malformed(self):
549
conflicts = self.find_conflicts()
550
if len(conflicts) != 0:
551
raise MalformedTransform(conflicts=conflicts)
553
def _add_tree_children(self):
554
"""Add all the children of all active parents to the known paths.
556
Active parents are those which gain children, and those which are
557
removed. This is a necessary first step in detecting conflicts.
559
parents = list(self.by_parent())
560
parents.extend([t for t in self._removed_contents if
561
self.tree_kind(t) == 'directory'])
562
for trans_id in self._removed_id:
563
path = self.tree_path(trans_id)
565
if self._tree.stored_kind(path) == 'directory':
566
parents.append(trans_id)
567
elif self.tree_kind(trans_id) == 'directory':
568
parents.append(trans_id)
570
for parent_id in parents:
571
# ensure that all children are registered with the transaction
572
list(self.iter_tree_children(parent_id))
574
def _has_named_child(self, name, parent_id, known_children):
575
"""Does a parent already have a name child.
577
:param name: The searched for name.
579
:param parent_id: The parent for which the check is made.
581
:param known_children: The already known children. This should have
582
been recently obtained from `self.by_parent.get(parent_id)`
583
(or will be if None is passed).
585
if known_children is None:
586
known_children = self.by_parent().get(parent_id, [])
587
for child in known_children:
588
if self.final_name(child) == name:
590
parent_path = self._tree_id_paths.get(parent_id, None)
591
if parent_path is None:
592
# No parent... no children
594
child_path = joinpath(parent_path, name)
595
child_id = self._tree_path_ids.get(child_path, None)
597
# Not known by the tree transform yet, check the filesystem
598
return osutils.lexists(self._tree.abspath(child_path))
600
raise AssertionError('child_id is missing: %s, %s, %s'
601
% (name, parent_id, child_id))
603
def _available_backup_name(self, name, target_id):
604
"""Find an available backup name.
606
:param name: The basename of the file.
608
:param target_id: The directory trans_id where the backup should
611
known_children = self.by_parent().get(target_id, [])
612
return osutils.available_backup_name(
614
lambda base: self._has_named_child(
615
base, target_id, known_children))
617
def _parent_loops(self):
618
"""No entry should be its own ancestor"""
620
for trans_id in self._new_parent:
623
while parent_id != ROOT_PARENT:
626
parent_id = self.final_parent(parent_id)
629
if parent_id == trans_id:
630
conflicts.append(('parent loop', trans_id))
631
if parent_id in seen:
635
def _unversioned_parents(self, by_parent):
636
"""If parent directories are versioned, children must be versioned."""
638
for parent_id, children in viewitems(by_parent):
639
if parent_id == ROOT_PARENT:
641
if self.final_file_id(parent_id) is not None:
643
for child_id in children:
644
if self.final_file_id(child_id) is not None:
645
conflicts.append(('unversioned parent', parent_id))
649
def _improper_versioning(self):
650
"""Cannot version a file with no contents, or a bad type.
652
However, existing entries with no contents are okay.
655
for trans_id in self._new_id:
656
kind = self.final_kind(trans_id)
657
if kind == 'symlink' and not self._tree.supports_symlinks():
658
# Ignore symlinks as they are not supported on this platform
661
conflicts.append(('versioning no contents', trans_id))
663
if not self._tree.versionable_kind(kind):
664
conflicts.append(('versioning bad kind', trans_id, kind))
667
def _executability_conflicts(self):
668
"""Check for bad executability changes.
670
Only versioned files may have their executability set, because
671
1. only versioned entries can have executability under windows
672
2. only files can be executable. (The execute bit on a directory
673
does not indicate searchability)
676
for trans_id in self._new_executability:
677
if self.final_file_id(trans_id) is None:
678
conflicts.append(('unversioned executability', trans_id))
680
if self.final_kind(trans_id) != "file":
681
conflicts.append(('non-file executability', trans_id))
684
def _overwrite_conflicts(self):
685
"""Check for overwrites (not permitted on Win32)"""
687
for trans_id in self._new_contents:
688
if self.tree_kind(trans_id) is None:
690
if trans_id not in self._removed_contents:
691
conflicts.append(('overwrite', trans_id,
692
self.final_name(trans_id)))
695
def _duplicate_entries(self, by_parent):
696
"""No directory may have two entries with the same name."""
698
if (self._new_name, self._new_parent) == ({}, {}):
700
for children in viewvalues(by_parent):
702
for child_tid in children:
703
name = self.final_name(child_tid)
705
# Keep children only if they still exist in the end
706
if not self._case_sensitive_target:
708
name_ids.append((name, child_tid))
712
for name, trans_id in name_ids:
713
kind = self.final_kind(trans_id)
714
file_id = self.final_file_id(trans_id)
715
if kind is None and file_id is None:
717
if name == last_name:
718
conflicts.append(('duplicate', last_trans_id, trans_id,
721
last_trans_id = trans_id
724
def _duplicate_ids(self):
725
"""Each inventory id may only be used once"""
728
all_ids = self._tree.all_file_ids()
729
except errors.UnsupportedOperation:
730
# it's okay for non-file-id trees to raise UnsupportedOperation.
732
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
734
active_tree_ids = all_ids.difference(removed_tree_ids)
735
for trans_id, file_id in viewitems(self._new_id):
736
if file_id in active_tree_ids:
737
path = self._tree.id2path(file_id)
738
old_trans_id = self.trans_id_tree_path(path)
739
conflicts.append(('duplicate id', old_trans_id, trans_id))
742
def _parent_type_conflicts(self, by_parent):
743
"""Children must have a directory parent"""
745
for parent_id, children in viewitems(by_parent):
746
if parent_id == ROOT_PARENT:
749
for child_id in children:
750
if self.final_kind(child_id) is not None:
755
# There is at least a child, so we need an existing directory to
757
kind = self.final_kind(parent_id)
759
# The directory will be deleted
760
conflicts.append(('missing parent', parent_id))
761
elif kind != "directory":
762
# Meh, we need a *directory* to put something in it
763
conflicts.append(('non-directory parent', parent_id))
766
def _set_executability(self, path, trans_id):
767
"""Set the executability of versioned files """
768
if self._tree._supports_executable():
769
new_executability = self._new_executability[trans_id]
770
abspath = self._tree.abspath(path)
771
current_mode = os.stat(abspath).st_mode
772
if new_executability:
775
to_mode = current_mode | (0o100 & ~umask)
776
# Enable x-bit for others only if they can read it.
777
if current_mode & 0o004:
778
to_mode |= 0o001 & ~umask
779
if current_mode & 0o040:
780
to_mode |= 0o010 & ~umask
782
to_mode = current_mode & ~0o111
783
osutils.chmod_if_possible(abspath, to_mode)
785
def _new_entry(self, name, parent_id, file_id):
786
"""Helper function to create a new filesystem entry."""
787
trans_id = self.create_path(name, parent_id)
788
if file_id is not None:
789
self.version_file(file_id, trans_id)
792
def new_file(self, name, parent_id, contents, file_id=None,
793
executable=None, sha1=None):
794
"""Convenience method to create files.
796
name is the name of the file to create.
797
parent_id is the transaction id of the parent directory of the file.
798
contents is an iterator of bytestrings, which will be used to produce
800
:param file_id: The inventory ID of the file, if it is to be versioned.
801
:param executable: Only valid when a file_id has been supplied.
803
trans_id = self._new_entry(name, parent_id, file_id)
804
# TODO: rather than scheduling a set_executable call,
805
# have create_file create the file with the right mode.
806
self.create_file(contents, trans_id, sha1=sha1)
807
if executable is not None:
808
self.set_executability(executable, trans_id)
811
def new_directory(self, name, parent_id, file_id=None):
812
"""Convenience method to create directories.
814
name is the name of the directory to create.
815
parent_id is the transaction id of the parent directory of the
817
file_id is the inventory ID of the directory, if it is to be versioned.
819
trans_id = self._new_entry(name, parent_id, file_id)
820
self.create_directory(trans_id)
823
def new_symlink(self, name, parent_id, target, file_id=None):
824
"""Convenience method to create symbolic link.
826
name is the name of the symlink to create.
827
parent_id is the transaction id of the parent directory of the symlink.
828
target is a bytestring of the target of the symlink.
829
file_id is the inventory ID of the file, if it is to be versioned.
831
trans_id = self._new_entry(name, parent_id, file_id)
832
self.create_symlink(target, trans_id)
835
def new_orphan(self, trans_id, parent_id):
836
"""Schedule an item to be orphaned.
838
When a directory is about to be removed, its children, if they are not
839
versioned are moved out of the way: they don't have a parent anymore.
841
:param trans_id: The trans_id of the existing item.
842
:param parent_id: The parent trans_id of the item.
844
raise NotImplementedError(self.new_orphan)
846
def _get_potential_orphans(self, dir_id):
847
"""Find the potential orphans in a directory.
849
A directory can't be safely deleted if there are versioned files in it.
850
If all the contained files are unversioned then they can be orphaned.
852
The 'None' return value means that the directory contains at least one
853
versioned file and should not be deleted.
855
:param dir_id: The directory trans id.
857
:return: A list of the orphan trans ids or None if at least one
858
versioned file is present.
861
# Find the potential orphans, stop if one item should be kept
862
for child_tid in self.by_parent()[dir_id]:
863
if child_tid in self._removed_contents:
864
# The child is removed as part of the transform. Since it was
865
# versioned before, it's not an orphan
867
elif self.final_file_id(child_tid) is None:
868
# The child is not versioned
869
orphans.append(child_tid)
871
# We have a versioned file here, searching for orphans is
877
def _affected_ids(self):
878
"""Return the set of transform ids affected by the transform"""
879
trans_ids = set(self._removed_id)
880
trans_ids.update(self._new_id)
881
trans_ids.update(self._removed_contents)
882
trans_ids.update(self._new_contents)
883
trans_ids.update(self._new_executability)
884
trans_ids.update(self._new_name)
885
trans_ids.update(self._new_parent)
888
def _get_file_id_maps(self):
889
"""Return mapping of file_ids to trans_ids in the to and from states"""
890
trans_ids = self._affected_ids()
893
# Build up two dicts: trans_ids associated with file ids in the
894
# FROM state, vs the TO state.
895
for trans_id in trans_ids:
896
from_file_id = self.tree_file_id(trans_id)
897
if from_file_id is not None:
898
from_trans_ids[from_file_id] = trans_id
899
to_file_id = self.final_file_id(trans_id)
900
if to_file_id is not None:
901
to_trans_ids[to_file_id] = trans_id
902
return from_trans_ids, to_trans_ids
904
def _from_file_data(self, from_trans_id, from_versioned, from_path):
905
"""Get data about a file in the from (tree) state
907
Return a (name, parent, kind, executable) tuple
909
from_path = self._tree_id_paths.get(from_trans_id)
911
# get data from working tree if versioned
912
from_entry = next(self._tree.iter_entries_by_dir(
913
specific_files=[from_path]))[1]
914
from_name = from_entry.name
915
from_parent = from_entry.parent_id
918
if from_path is None:
919
# File does not exist in FROM state
923
# File exists, but is not versioned. Have to use path-
925
from_name = os.path.basename(from_path)
926
tree_parent = self.get_tree_parent(from_trans_id)
927
from_parent = self.tree_file_id(tree_parent)
928
if from_path is not None:
929
from_kind, from_executable, from_stats = \
930
self._tree._comparison_data(from_entry, from_path)
933
from_executable = False
934
return from_name, from_parent, from_kind, from_executable
936
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
937
"""Get data about a file in the to (target) state
939
Return a (name, parent, kind, executable) tuple
941
to_name = self.final_name(to_trans_id)
942
to_kind = self.final_kind(to_trans_id)
943
to_parent = self.final_file_id(self.final_parent(to_trans_id))
944
if to_trans_id in self._new_executability:
945
to_executable = self._new_executability[to_trans_id]
946
elif to_trans_id == from_trans_id:
947
to_executable = from_executable
949
to_executable = False
950
return to_name, to_parent, to_kind, to_executable
952
def iter_changes(self):
953
"""Produce output in the same format as Tree.iter_changes.
955
Will produce nonsensical results if invoked while inventory/filesystem
956
conflicts (as reported by TreeTransform.find_conflicts()) are present.
958
This reads the Transform, but only reproduces changes involving a
959
file_id. Files that are not versioned in either of the FROM or TO
960
states are not reflected.
962
final_paths = FinalPaths(self)
963
from_trans_ids, to_trans_ids = self._get_file_id_maps()
965
# Now iterate through all active file_ids
966
for file_id in set(from_trans_ids).union(to_trans_ids):
968
from_trans_id = from_trans_ids.get(file_id)
969
# find file ids, and determine versioning state
970
if from_trans_id is None:
971
from_versioned = False
972
from_trans_id = to_trans_ids[file_id]
974
from_versioned = True
975
to_trans_id = to_trans_ids.get(file_id)
976
if to_trans_id is None:
978
to_trans_id = from_trans_id
982
if not from_versioned:
985
from_path = self._tree_id_paths.get(from_trans_id)
989
to_path = final_paths.get_path(to_trans_id)
991
from_name, from_parent, from_kind, from_executable = \
992
self._from_file_data(from_trans_id, from_versioned, from_path)
994
to_name, to_parent, to_kind, to_executable = \
995
self._to_file_data(to_trans_id, from_trans_id, from_executable)
997
if from_kind != to_kind:
999
elif to_kind in ('file', 'symlink') and (
1000
to_trans_id != from_trans_id
1001
or to_trans_id in self._new_contents):
1003
if (not modified and from_versioned == to_versioned
1004
and from_parent == to_parent and from_name == to_name
1005
and from_executable == to_executable):
1009
file_id, (from_path, to_path), modified,
1010
(from_versioned, to_versioned),
1011
(from_parent, to_parent),
1012
(from_name, to_name),
1013
(from_kind, to_kind),
1014
(from_executable, to_executable)))
1017
return (c.path[0] or '', c.path[1] or '')
1018
return iter(sorted(results, key=path_key))
1020
def get_preview_tree(self):
1021
"""Return a tree representing the result of the transform.
1023
The tree is a snapshot, and altering the TreeTransform will invalidate
1026
return _PreviewTree(self)
1028
def commit(self, branch, message, merge_parents=None, strict=False,
1029
timestamp=None, timezone=None, committer=None, authors=None,
1030
revprops=None, revision_id=None):
1031
"""Commit the result of this TreeTransform to a branch.
1033
:param branch: The branch to commit to.
1034
:param message: The message to attach to the commit.
1035
:param merge_parents: Additional parent revision-ids specified by
1037
:param strict: If True, abort the commit if there are unversioned
1039
:param timestamp: if not None, seconds-since-epoch for the time and
1040
date. (May be a float.)
1041
:param timezone: Optional timezone for timestamp, as an offset in
1043
:param committer: Optional committer in email-id format.
1044
(e.g. "J Random Hacker <jrandom@example.com>")
1045
:param authors: Optional list of authors in email-id format.
1046
:param revprops: Optional dictionary of revision properties.
1047
:param revision_id: Optional revision id. (Specifying a revision-id
1048
may reduce performance for some non-native formats.)
1049
:return: The revision_id of the revision committed.
1051
self._check_malformed()
1053
unversioned = set(self._new_contents).difference(set(self._new_id))
1054
for trans_id in unversioned:
1055
if self.final_file_id(trans_id) is None:
1056
raise errors.StrictCommitFailed()
1058
revno, last_rev_id = branch.last_revision_info()
1059
if last_rev_id == _mod_revision.NULL_REVISION:
1060
if merge_parents is not None:
1061
raise ValueError('Cannot supply merge parents for first'
1065
parent_ids = [last_rev_id]
1066
if merge_parents is not None:
1067
parent_ids.extend(merge_parents)
1068
if self._tree.get_revision_id() != last_rev_id:
1069
raise ValueError('TreeTransform not based on branch basis: %s' %
1070
self._tree.get_revision_id().decode('utf-8'))
1071
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1072
builder = branch.get_commit_builder(parent_ids,
1073
timestamp=timestamp,
1075
committer=committer,
1077
revision_id=revision_id)
1078
preview = self.get_preview_tree()
1079
list(builder.record_iter_changes(preview, last_rev_id,
1080
self.iter_changes()))
1081
builder.finish_inventory()
1082
revision_id = builder.commit(message)
1083
branch.set_last_revision_info(revno + 1, revision_id)
1086
def _text_parent(self, trans_id):
1087
path = self.tree_path(trans_id)
1089
if path is None or self._tree.kind(path) != 'file':
1091
except errors.NoSuchFile:
1095
def _get_parents_texts(self, trans_id):
1096
"""Get texts for compression parents of this file."""
1097
path = self._text_parent(trans_id)
1100
return (self._tree.get_file_text(path),)
1102
def _get_parents_lines(self, trans_id):
1103
"""Get lines for compression parents of this file."""
1104
path = self._text_parent(trans_id)
1107
return (self._tree.get_file_lines(path),)
1109
def serialize(self, serializer):
1110
"""Serialize this TreeTransform.
1112
:param serializer: A Serialiser like pack.ContainerSerializer.
1114
new_name = {k.encode('utf-8'): v.encode('utf-8')
1115
for k, v in viewitems(self._new_name)}
1116
new_parent = {k.encode('utf-8'): v.encode('utf-8')
1117
for k, v in viewitems(self._new_parent)}
1118
new_id = {k.encode('utf-8'): v
1119
for k, v in viewitems(self._new_id)}
1120
new_executability = {k.encode('utf-8'): int(v)
1121
for k, v in viewitems(self._new_executability)}
1122
tree_path_ids = {k.encode('utf-8'): v.encode('utf-8')
1123
for k, v in viewitems(self._tree_path_ids)}
1124
non_present_ids = {k: v.encode('utf-8')
1125
for k, v in viewitems(self._non_present_ids)}
1126
removed_contents = [trans_id.encode('utf-8')
1127
for trans_id in self._removed_contents]
1128
removed_id = [trans_id.encode('utf-8')
1129
for trans_id in self._removed_id]
1131
b'_id_number': self._id_number,
1132
b'_new_name': new_name,
1133
b'_new_parent': new_parent,
1134
b'_new_executability': new_executability,
1136
b'_tree_path_ids': tree_path_ids,
1137
b'_removed_id': removed_id,
1138
b'_removed_contents': removed_contents,
1139
b'_non_present_ids': non_present_ids,
1141
yield serializer.bytes_record(bencode.bencode(attribs),
1143
for trans_id, kind in sorted(viewitems(self._new_contents)):
1145
with open(self._limbo_name(trans_id), 'rb') as cur_file:
1146
lines = cur_file.readlines()
1147
parents = self._get_parents_lines(trans_id)
1148
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1149
content = b''.join(mpdiff.to_patch())
1150
if kind == 'directory':
1152
if kind == 'symlink':
1153
content = self._read_symlink_target(trans_id)
1154
if not isinstance(content, bytes):
1155
content = content.encode('utf-8')
1156
yield serializer.bytes_record(
1157
content, ((trans_id.encode('utf-8'), kind.encode('ascii')),))
1159
def deserialize(self, records):
1160
"""Deserialize a stored TreeTransform.
1162
:param records: An iterable of (names, content) tuples, as per
1163
pack.ContainerPushParser.
1165
names, content = next(records)
1166
attribs = bencode.bdecode(content)
1167
self._id_number = attribs[b'_id_number']
1168
self._new_name = {k.decode('utf-8'): v.decode('utf-8')
1169
for k, v in viewitems(attribs[b'_new_name'])}
1170
self._new_parent = {k.decode('utf-8'): v.decode('utf-8')
1171
for k, v in viewitems(attribs[b'_new_parent'])}
1172
self._new_executability = {
1173
k.decode('utf-8'): bool(v)
1174
for k, v in viewitems(attribs[b'_new_executability'])}
1175
self._new_id = {k.decode('utf-8'): v
1176
for k, v in viewitems(attribs[b'_new_id'])}
1177
self._r_new_id = {v: k for k, v in viewitems(self._new_id)}
1178
self._tree_path_ids = {}
1179
self._tree_id_paths = {}
1180
for bytepath, trans_id in viewitems(attribs[b'_tree_path_ids']):
1181
path = bytepath.decode('utf-8')
1182
trans_id = trans_id.decode('utf-8')
1183
self._tree_path_ids[path] = trans_id
1184
self._tree_id_paths[trans_id] = path
1185
self._removed_id = {trans_id.decode('utf-8')
1186
for trans_id in attribs[b'_removed_id']}
1187
self._removed_contents = set(
1188
trans_id.decode('utf-8')
1189
for trans_id in attribs[b'_removed_contents'])
1190
self._non_present_ids = {
1191
k: v.decode('utf-8')
1192
for k, v in viewitems(attribs[b'_non_present_ids'])}
1193
for ((trans_id, kind),), content in records:
1194
trans_id = trans_id.decode('utf-8')
1195
kind = kind.decode('ascii')
1197
mpdiff = multiparent.MultiParent.from_patch(content)
1198
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1199
self.create_file(lines, trans_id)
1200
if kind == 'directory':
1201
self.create_directory(trans_id)
1202
if kind == 'symlink':
1203
self.create_symlink(content.decode('utf-8'), trans_id)
1205
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1206
"""Schedule creation of a new file.
1210
:param contents: an iterator of strings, all of which will be written
1211
to the target destination.
1212
:param trans_id: TreeTransform handle
1213
:param mode_id: If not None, force the mode of the target file to match
1214
the mode of the object referenced by mode_id.
1215
Otherwise, we will try to preserve mode bits of an existing file.
1216
:param sha1: If the sha1 of this content is already known, pass it in.
1217
We can use it to prevent future sha1 computations.
1219
raise NotImplementedError(self.create_file)
1221
def create_directory(self, trans_id):
1222
"""Schedule creation of a new directory.
1224
See also new_directory.
1226
raise NotImplementedError(self.create_directory)
1228
def create_symlink(self, target, trans_id):
1229
"""Schedule creation of a new symbolic link.
1231
target is a bytestring.
1232
See also new_symlink.
1234
raise NotImplementedError(self.create_symlink)
1236
def create_hardlink(self, path, trans_id):
1237
"""Schedule creation of a hard link"""
1238
raise NotImplementedError(self.create_hardlink)
1240
def cancel_creation(self, trans_id):
1241
"""Cancel the creation of new file contents."""
1242
raise NotImplementedError(self.cancel_creation)
1245
class DiskTreeTransform(TreeTransformBase):
1246
"""Tree transform storing its contents on disk."""
1248
def __init__(self, tree, limbodir, pb=None, case_sensitive=True):
1250
:param tree: The tree that will be transformed, but not necessarily
1252
:param limbodir: A directory where new files can be stored until
1253
they are installed in their proper places
1255
:param case_sensitive: If True, the target of the transform is
1256
case sensitive, not just case preserving.
1258
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1259
self._limbodir = limbodir
1260
self._deletiondir = None
1261
# A mapping of transform ids to their limbo filename
1262
self._limbo_files = {}
1263
self._possibly_stale_limbo_files = set()
1264
# A mapping of transform ids to a set of the transform ids of children
1265
# that their limbo directory has
1266
self._limbo_children = {}
1267
# Map transform ids to maps of child filename to child transform id
1268
self._limbo_children_names = {}
1269
# List of transform ids that need to be renamed from limbo into place
1270
self._needs_rename = set()
1271
self._creation_mtime = None
1272
self._create_symlinks = osutils.supports_symlinks(self._limbodir)
1275
"""Release the working tree lock, if held, clean up limbo dir.
1277
This is required if apply has not been invoked, but can be invoked
1280
if self._tree is None:
1283
limbo_paths = list(viewvalues(self._limbo_files))
1284
limbo_paths.extend(self._possibly_stale_limbo_files)
1285
limbo_paths.sort(reverse=True)
1286
for path in limbo_paths:
1289
except OSError as e:
1290
if e.errno != errno.ENOENT:
1292
# XXX: warn? perhaps we just got interrupted at an
1293
# inconvenient moment, but perhaps files are disappearing
1296
delete_any(self._limbodir)
1298
# We don't especially care *why* the dir is immortal.
1299
raise ImmortalLimbo(self._limbodir)
1301
if self._deletiondir is not None:
1302
delete_any(self._deletiondir)
1304
raise errors.ImmortalPendingDeletion(self._deletiondir)
1306
TreeTransformBase.finalize(self)
1308
def _limbo_supports_executable(self):
1309
"""Check if the limbo path supports the executable bit."""
1310
return osutils.supports_executable(self._limbodir)
1312
def _limbo_name(self, trans_id):
1313
"""Generate the limbo name of a file"""
1314
limbo_name = self._limbo_files.get(trans_id)
1315
if limbo_name is None:
1316
limbo_name = self._generate_limbo_path(trans_id)
1317
self._limbo_files[trans_id] = limbo_name
1320
def _generate_limbo_path(self, trans_id):
1321
"""Generate a limbo path using the trans_id as the relative path.
1323
This is suitable as a fallback, and when the transform should not be
1324
sensitive to the path encoding of the limbo directory.
1326
self._needs_rename.add(trans_id)
1327
return pathjoin(self._limbodir, trans_id)
1329
def adjust_path(self, name, parent, trans_id):
1330
previous_parent = self._new_parent.get(trans_id)
1331
previous_name = self._new_name.get(trans_id)
1332
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1333
if (trans_id in self._limbo_files
1334
and trans_id not in self._needs_rename):
1335
self._rename_in_limbo([trans_id])
1336
if previous_parent != parent:
1337
self._limbo_children[previous_parent].remove(trans_id)
1338
if previous_parent != parent or previous_name != name:
1339
del self._limbo_children_names[previous_parent][previous_name]
1341
def _rename_in_limbo(self, trans_ids):
1342
"""Fix limbo names so that the right final path is produced.
1344
This means we outsmarted ourselves-- we tried to avoid renaming
1345
these files later by creating them with their final names in their
1346
final parents. But now the previous name or parent is no longer
1347
suitable, so we have to rename them.
1349
Even for trans_ids that have no new contents, we must remove their
1350
entries from _limbo_files, because they are now stale.
1352
for trans_id in trans_ids:
1353
old_path = self._limbo_files[trans_id]
1354
self._possibly_stale_limbo_files.add(old_path)
1355
del self._limbo_files[trans_id]
1356
if trans_id not in self._new_contents:
1358
new_path = self._limbo_name(trans_id)
1359
os.rename(old_path, new_path)
1360
self._possibly_stale_limbo_files.remove(old_path)
1361
for descendant in self._limbo_descendants(trans_id):
1362
desc_path = self._limbo_files[descendant]
1363
desc_path = new_path + desc_path[len(old_path):]
1364
self._limbo_files[descendant] = desc_path
1366
def _limbo_descendants(self, trans_id):
1367
"""Return the set of trans_ids whose limbo paths descend from this."""
1368
descendants = set(self._limbo_children.get(trans_id, []))
1369
for descendant in list(descendants):
1370
descendants.update(self._limbo_descendants(descendant))
1373
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1374
"""Schedule creation of a new file.
1378
:param contents: an iterator of strings, all of which will be written
1379
to the target destination.
1380
:param trans_id: TreeTransform handle
1381
:param mode_id: If not None, force the mode of the target file to match
1382
the mode of the object referenced by mode_id.
1383
Otherwise, we will try to preserve mode bits of an existing file.
1384
:param sha1: If the sha1 of this content is already known, pass it in.
1385
We can use it to prevent future sha1 computations.
1387
name = self._limbo_name(trans_id)
1388
with open(name, 'wb') as f:
1389
unique_add(self._new_contents, trans_id, 'file')
1390
f.writelines(contents)
1391
self._set_mtime(name)
1392
self._set_mode(trans_id, mode_id, S_ISREG)
1393
# It is unfortunate we have to use lstat instead of fstat, but we just
1394
# used utime and chmod on the file, so we need the accurate final
1396
if sha1 is not None:
1397
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1399
def _read_symlink_target(self, trans_id):
1400
return os.readlink(self._limbo_name(trans_id))
1402
def _set_mtime(self, path):
1403
"""All files that are created get the same mtime.
1405
This time is set by the first object to be created.
1407
if self._creation_mtime is None:
1408
self._creation_mtime = time.time()
1409
os.utime(path, (self._creation_mtime, self._creation_mtime))
1411
def create_hardlink(self, path, trans_id):
1412
"""Schedule creation of a hard link"""
1413
name = self._limbo_name(trans_id)
1416
except OSError as e:
1417
if e.errno != errno.EPERM:
1419
raise errors.HardLinkNotSupported(path)
1421
unique_add(self._new_contents, trans_id, 'file')
1422
except BaseException:
1423
# Clean up the file, it never got registered so
1424
# TreeTransform.finalize() won't clean it up.
1428
def create_directory(self, trans_id):
1429
"""Schedule creation of a new directory.
1431
See also new_directory.
1433
os.mkdir(self._limbo_name(trans_id))
1434
unique_add(self._new_contents, trans_id, 'directory')
1436
def create_symlink(self, target, trans_id):
1437
"""Schedule creation of a new symbolic link.
1439
target is a bytestring.
1440
See also new_symlink.
1442
if self._create_symlinks:
1443
os.symlink(target, self._limbo_name(trans_id))
1446
path = FinalPaths(self).get_path(trans_id)
1450
'Unable to create symlink "%s" on this filesystem.' % (path,))
1451
# We add symlink to _new_contents even if they are unsupported
1452
# and not created. These entries are subsequently used to avoid
1453
# conflicts on platforms that don't support symlink
1454
unique_add(self._new_contents, trans_id, 'symlink')
1456
def cancel_creation(self, trans_id):
1457
"""Cancel the creation of new file contents."""
1458
del self._new_contents[trans_id]
1459
if trans_id in self._observed_sha1s:
1460
del self._observed_sha1s[trans_id]
1461
children = self._limbo_children.get(trans_id)
1462
# if this is a limbo directory with children, move them before removing
1464
if children is not None:
1465
self._rename_in_limbo(children)
1466
del self._limbo_children[trans_id]
1467
del self._limbo_children_names[trans_id]
1468
delete_any(self._limbo_name(trans_id))
1470
def new_orphan(self, trans_id, parent_id):
1471
conf = self._tree.get_config_stack()
1472
handle_orphan = conf.get('transform.orphan_policy')
1473
handle_orphan(self, trans_id, parent_id)
1476
class OrphaningError(errors.BzrError):
1478
# Only bugs could lead to such exception being seen by the user
1479
internal_error = True
1480
_fmt = "Error while orphaning %s in %s directory"
1482
def __init__(self, orphan, parent):
1483
errors.BzrError.__init__(self)
1484
self.orphan = orphan
1485
self.parent = parent
1488
class OrphaningForbidden(OrphaningError):
1490
_fmt = "Policy: %s doesn't allow creating orphans."
1492
def __init__(self, policy):
1493
errors.BzrError.__init__(self)
1494
self.policy = policy
1497
def move_orphan(tt, orphan_id, parent_id):
1498
"""See TreeTransformBase.new_orphan.
1500
This creates a new orphan in the `brz-orphans` dir at the root of the
1503
:param tt: The TreeTransform orphaning `trans_id`.
1505
:param orphan_id: The trans id that should be orphaned.
1507
:param parent_id: The orphan parent trans id.
1509
# Add the orphan dir if it doesn't exist
1510
orphan_dir_basename = 'brz-orphans'
1511
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1512
if tt.final_kind(od_id) is None:
1513
tt.create_directory(od_id)
1514
parent_path = tt._tree_id_paths[parent_id]
1515
# Find a name that doesn't exist yet in the orphan dir
1516
actual_name = tt.final_name(orphan_id)
1517
new_name = tt._available_backup_name(actual_name, od_id)
1518
tt.adjust_path(new_name, od_id, orphan_id)
1519
trace.warning('%s has been orphaned in %s'
1520
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1523
def refuse_orphan(tt, orphan_id, parent_id):
1524
"""See TreeTransformBase.new_orphan.
1526
This refuses to create orphan, letting the caller handle the conflict.
1528
raise OrphaningForbidden('never')
1531
orphaning_registry = registry.Registry()
1532
orphaning_registry.register(
1533
u'conflict', refuse_orphan,
1534
'Leave orphans in place and create a conflict on the directory.')
1535
orphaning_registry.register(
1536
u'move', move_orphan,
1537
'Move orphans into the brz-orphans directory.')
1538
orphaning_registry._set_default_key(u'conflict')
1541
opt_transform_orphan = _mod_config.RegistryOption(
1542
'transform.orphan_policy', orphaning_registry,
1543
help='Policy for orphaned files during transform operations.',
1547
class TreeTransform(DiskTreeTransform):
1548
"""Represent a tree transformation.
1550
This object is designed to support incremental generation of the transform,
1553
However, it gives optimum performance when parent directories are created
1554
before their contents. The transform is then able to put child files
1555
directly in their parent directory, avoiding later renames.
1557
It is easy to produce malformed transforms, but they are generally
1558
harmless. Attempting to apply a malformed transform will cause an
1559
exception to be raised before any modifications are made to the tree.
1561
Many kinds of malformed transforms can be corrected with the
1562
resolve_conflicts function. The remaining ones indicate programming error,
1563
such as trying to create a file with no path.
1565
Two sets of file creation methods are supplied. Convenience methods are:
1570
These are composed of the low-level methods:
1572
* create_file or create_directory or create_symlink
1576
Transform/Transaction ids
1577
-------------------------
1578
trans_ids are temporary ids assigned to all files involved in a transform.
1579
It's possible, even common, that not all files in the Tree have trans_ids.
1581
trans_ids are used because filenames and file_ids are not good enough
1582
identifiers; filenames change, and not all files have file_ids. File-ids
1583
are also associated with trans-ids, so that moving a file moves its
1586
trans_ids are only valid for the TreeTransform that generated them.
1590
Limbo is a temporary directory use to hold new versions of files.
1591
Files are added to limbo by create_file, create_directory, create_symlink,
1592
and their convenience variants (new_*). Files may be removed from limbo
1593
using cancel_creation. Files are renamed from limbo into their final
1594
location as part of TreeTransform.apply
1596
Limbo must be cleaned up, by either calling TreeTransform.apply or
1597
calling TreeTransform.finalize.
1599
Files are placed into limbo inside their parent directories, where
1600
possible. This reduces subsequent renames, and makes operations involving
1601
lots of files faster. This optimization is only possible if the parent
1602
directory is created *before* creating any of its children, so avoid
1603
creating children before parents, where possible.
1607
This temporary directory is used by _FileMover for storing files that are
1608
about to be deleted. In case of rollback, the files will be restored.
1609
FileMover does not delete files until it is sure that a rollback will not
1613
def __init__(self, tree, pb=None):
1614
"""Note: a tree_write lock is taken on the tree.
1616
Use TreeTransform.finalize() to release the lock (can be omitted if
1617
TreeTransform.apply() called).
1619
tree.lock_tree_write()
1621
limbodir = urlutils.local_path_from_url(
1622
tree._transport.abspath('limbo'))
1623
osutils.ensure_empty_directory_exists(
1625
errors.ExistingLimbo)
1626
deletiondir = urlutils.local_path_from_url(
1627
tree._transport.abspath('pending-deletion'))
1628
osutils.ensure_empty_directory_exists(
1630
errors.ExistingPendingDeletion)
1631
except BaseException:
1635
# Cache of realpath results, to speed up canonical_path
1636
self._realpaths = {}
1637
# Cache of relpath results, to speed up canonical_path
1639
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1640
tree.case_sensitive)
1641
self._deletiondir = deletiondir
1643
def canonical_path(self, path):
1644
"""Get the canonical tree-relative path"""
1645
# don't follow final symlinks
1646
abs = self._tree.abspath(path)
1647
if abs in self._relpaths:
1648
return self._relpaths[abs]
1649
dirname, basename = os.path.split(abs)
1650
if dirname not in self._realpaths:
1651
self._realpaths[dirname] = os.path.realpath(dirname)
1652
dirname = self._realpaths[dirname]
1653
abs = pathjoin(dirname, basename)
1654
if dirname in self._relpaths:
1655
relpath = pathjoin(self._relpaths[dirname], basename)
1656
relpath = relpath.rstrip('/\\')
1658
relpath = self._tree.relpath(abs)
1659
self._relpaths[abs] = relpath
1662
def tree_kind(self, trans_id):
1663
"""Determine the file kind in the working tree.
1665
:returns: The file kind or None if the file does not exist
1667
path = self._tree_id_paths.get(trans_id)
1671
return file_kind(self._tree.abspath(path))
1672
except errors.NoSuchFile:
1675
def _set_mode(self, trans_id, mode_id, typefunc):
1676
"""Set the mode of new file contents.
1677
The mode_id is the existing file to get the mode from (often the same
1678
as trans_id). The operation is only performed if there's a mode match
1679
according to typefunc.
1684
old_path = self._tree_id_paths[mode_id]
1688
mode = os.stat(self._tree.abspath(old_path)).st_mode
1689
except OSError as e:
1690
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1691
# Either old_path doesn't exist, or the parent of the
1692
# target is not a directory (but will be one eventually)
1693
# Either way, we know it doesn't exist *right now*
1694
# See also bug #248448
1699
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1701
def iter_tree_children(self, parent_id):
1702
"""Iterate through the entry's tree children, if any"""
1704
path = self._tree_id_paths[parent_id]
1708
children = os.listdir(self._tree.abspath(path))
1709
except OSError as e:
1710
if not (osutils._is_error_enotdir(e) or
1711
e.errno in (errno.ENOENT, errno.ESRCH)):
1715
for child in children:
1716
childpath = joinpath(path, child)
1717
if self._tree.is_control_filename(childpath):
1719
yield self.trans_id_tree_path(childpath)
1721
def _generate_limbo_path(self, trans_id):
1722
"""Generate a limbo path using the final path if possible.
1724
This optimizes the performance of applying the tree transform by
1725
avoiding renames. These renames can be avoided only when the parent
1726
directory is already scheduled for creation.
1728
If the final path cannot be used, falls back to using the trans_id as
1731
parent = self._new_parent.get(trans_id)
1732
# if the parent directory is already in limbo (e.g. when building a
1733
# tree), choose a limbo name inside the parent, to reduce further
1735
use_direct_path = False
1736
if self._new_contents.get(parent) == 'directory':
1737
filename = self._new_name.get(trans_id)
1738
if filename is not None:
1739
if parent not in self._limbo_children:
1740
self._limbo_children[parent] = set()
1741
self._limbo_children_names[parent] = {}
1742
use_direct_path = True
1743
# the direct path can only be used if no other file has
1744
# already taken this pathname, i.e. if the name is unused, or
1745
# if it is already associated with this trans_id.
1746
elif self._case_sensitive_target:
1747
if (self._limbo_children_names[parent].get(filename)
1748
in (trans_id, None)):
1749
use_direct_path = True
1751
for l_filename, l_trans_id in viewitems(
1752
self._limbo_children_names[parent]):
1753
if l_trans_id == trans_id:
1755
if l_filename.lower() == filename.lower():
1758
use_direct_path = True
1760
if not use_direct_path:
1761
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1763
limbo_name = pathjoin(self._limbo_files[parent], filename)
1764
self._limbo_children[parent].add(trans_id)
1765
self._limbo_children_names[parent][filename] = trans_id
1768
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1769
"""Apply all changes to the inventory and filesystem.
1771
If filesystem or inventory conflicts are present, MalformedTransform
1774
If apply succeeds, finalize is not necessary.
1776
:param no_conflicts: if True, the caller guarantees there are no
1777
conflicts, so no check is made.
1778
:param precomputed_delta: An inventory delta to use instead of
1780
:param _mover: Supply an alternate FileMover, for testing
1782
for hook in MutableTree.hooks['pre_transform']:
1783
hook(self._tree, self)
1784
if not no_conflicts:
1785
self._check_malformed()
1786
with ui.ui_factory.nested_progress_bar() as child_pb:
1787
if precomputed_delta is None:
1788
child_pb.update(gettext('Apply phase'), 0, 2)
1789
inventory_delta = self._generate_inventory_delta()
1792
inventory_delta = precomputed_delta
1795
mover = _FileMover()
1799
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1800
self._apply_removals(mover)
1801
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1802
modified_paths = self._apply_insertions(mover)
1803
except BaseException:
1807
mover.apply_deletions()
1808
if self.final_file_id(self.root) is None:
1809
inventory_delta = [e for e in inventory_delta if e[0] != '']
1810
self._tree.apply_inventory_delta(inventory_delta)
1811
self._apply_observed_sha1s()
1814
return _TransformResults(modified_paths, self.rename_count)
1816
def _generate_inventory_delta(self):
1817
"""Generate an inventory delta for the current transform."""
1818
inventory_delta = []
1819
new_paths = self._inventory_altered()
1820
total_entries = len(new_paths) + len(self._removed_id)
1821
with ui.ui_factory.nested_progress_bar() as child_pb:
1822
for num, trans_id in enumerate(self._removed_id):
1824
child_pb.update(gettext('removing file'),
1826
if trans_id == self._new_root:
1827
file_id = self._tree.path2id('')
1829
file_id = self.tree_file_id(trans_id)
1830
# File-id isn't really being deleted, just moved
1831
if file_id in self._r_new_id:
1833
path = self._tree_id_paths[trans_id]
1834
inventory_delta.append((path, None, file_id, None))
1835
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1837
for num, (path, trans_id) in enumerate(new_paths):
1839
child_pb.update(gettext('adding file'),
1840
num + len(self._removed_id), total_entries)
1841
file_id = new_path_file_ids[trans_id]
1844
kind = self.final_kind(trans_id)
1846
kind = self._tree.stored_kind(self._tree.id2path(file_id))
1847
parent_trans_id = self.final_parent(trans_id)
1848
parent_file_id = new_path_file_ids.get(parent_trans_id)
1849
if parent_file_id is None:
1850
parent_file_id = self.final_file_id(parent_trans_id)
1851
if trans_id in self._new_reference_revision:
1852
new_entry = inventory.TreeReference(
1854
self._new_name[trans_id],
1855
self.final_file_id(self._new_parent[trans_id]),
1856
None, self._new_reference_revision[trans_id])
1858
new_entry = inventory.make_entry(kind,
1859
self.final_name(trans_id),
1860
parent_file_id, file_id)
1862
old_path = self._tree.id2path(new_entry.file_id)
1863
except errors.NoSuchId:
1865
new_executability = self._new_executability.get(trans_id)
1866
if new_executability is not None:
1867
new_entry.executable = new_executability
1868
inventory_delta.append(
1869
(old_path, path, new_entry.file_id, new_entry))
1870
return inventory_delta
1872
def _apply_removals(self, mover):
1873
"""Perform tree operations that remove directory/inventory names.
1875
That is, delete files that are to be deleted, and put any files that
1876
need renaming into limbo. This must be done in strict child-to-parent
1879
If inventory_delta is None, no inventory delta generation is performed.
1881
tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
1882
with ui.ui_factory.nested_progress_bar() as child_pb:
1883
for num, (path, trans_id) in enumerate(tree_paths):
1884
# do not attempt to move root into a subdirectory of itself.
1887
child_pb.update(gettext('removing file'), num, len(tree_paths))
1888
full_path = self._tree.abspath(path)
1889
if trans_id in self._removed_contents:
1890
delete_path = os.path.join(self._deletiondir, trans_id)
1891
mover.pre_delete(full_path, delete_path)
1892
elif (trans_id in self._new_name or
1893
trans_id in self._new_parent):
1895
mover.rename(full_path, self._limbo_name(trans_id))
1896
except errors.TransformRenameFailed as e:
1897
if e.errno != errno.ENOENT:
1900
self.rename_count += 1
1902
def _apply_insertions(self, mover):
1903
"""Perform tree operations that insert directory/inventory names.
1905
That is, create any files that need to be created, and restore from
1906
limbo any files that needed renaming. This must be done in strict
1907
parent-to-child order.
1909
If inventory_delta is None, no inventory delta is calculated, and
1910
no list of modified paths is returned.
1912
new_paths = self.new_paths(filesystem_only=True)
1914
with ui.ui_factory.nested_progress_bar() as child_pb:
1915
for num, (path, trans_id) in enumerate(new_paths):
1917
child_pb.update(gettext('adding file'),
1918
num, len(new_paths))
1919
full_path = self._tree.abspath(path)
1920
if trans_id in self._needs_rename:
1922
mover.rename(self._limbo_name(trans_id), full_path)
1923
except errors.TransformRenameFailed as e:
1924
# We may be renaming a dangling inventory id
1925
if e.errno != errno.ENOENT:
1928
self.rename_count += 1
1929
# TODO: if trans_id in self._observed_sha1s, we should
1930
# re-stat the final target, since ctime will be
1931
# updated by the change.
1932
if (trans_id in self._new_contents
1933
or self.path_changed(trans_id)):
1934
if trans_id in self._new_contents:
1935
modified_paths.append(full_path)
1936
if trans_id in self._new_executability:
1937
self._set_executability(path, trans_id)
1938
if trans_id in self._observed_sha1s:
1939
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1940
st = osutils.lstat(full_path)
1941
self._observed_sha1s[trans_id] = (o_sha1, st)
1942
for path, trans_id in new_paths:
1943
# new_paths includes stuff like workingtree conflicts. Only the
1944
# stuff in new_contents actually comes from limbo.
1945
if trans_id in self._limbo_files:
1946
del self._limbo_files[trans_id]
1947
self._new_contents.clear()
1948
return modified_paths
1950
def _apply_observed_sha1s(self):
1951
"""After we have finished renaming everything, update observed sha1s
1953
This has to be done after self._tree.apply_inventory_delta, otherwise
1954
it doesn't know anything about the files we are updating. Also, we want
1955
to do this as late as possible, so that most entries end up cached.
1957
# TODO: this doesn't update the stat information for directories. So
1958
# the first 'bzr status' will still need to rewrite
1959
# .bzr/checkout/dirstate. However, we at least don't need to
1960
# re-read all of the files.
1961
# TODO: If the operation took a while, we could do a time.sleep(3) here
1962
# to allow the clock to tick over and ensure we won't have any
1963
# problems. (we could observe start time, and finish time, and if
1964
# it is less than eg 10% overhead, add a sleep call.)
1965
paths = FinalPaths(self)
1966
for trans_id, observed in viewitems(self._observed_sha1s):
1967
path = paths.get_path(trans_id)
1968
self._tree._observed_sha1(path, observed)
1971
class TransformPreview(DiskTreeTransform):
1972
"""A TreeTransform for generating preview trees.
1974
Unlike TreeTransform, this version works when the input tree is a
1975
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1976
unversioned files in the input tree.
1979
def __init__(self, tree, pb=None, case_sensitive=True):
1981
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1982
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1984
def canonical_path(self, path):
1987
def tree_kind(self, trans_id):
1988
path = self._tree_id_paths.get(trans_id)
1991
kind = self._tree.path_content_summary(path)[0]
1992
if kind == 'missing':
1996
def _set_mode(self, trans_id, mode_id, typefunc):
1997
"""Set the mode of new file contents.
1998
The mode_id is the existing file to get the mode from (often the same
1999
as trans_id). The operation is only performed if there's a mode match
2000
according to typefunc.
2002
# is it ok to ignore this? probably
2005
def iter_tree_children(self, parent_id):
2006
"""Iterate through the entry's tree children, if any"""
2008
path = self._tree_id_paths[parent_id]
2012
entry = next(self._tree.iter_entries_by_dir(
2013
specific_files=[path]))[1]
2014
except StopIteration:
2016
children = getattr(entry, 'children', {})
2017
for child in children:
2018
childpath = joinpath(path, child)
2019
yield self.trans_id_tree_path(childpath)
2021
def new_orphan(self, trans_id, parent_id):
2022
raise NotImplementedError(self.new_orphan)
2025
class _PreviewTree(inventorytree.InventoryTree):
2026
"""Partial implementation of Tree to support show_diff_trees"""
2028
def __init__(self, transform):
2029
self._transform = transform
2030
self._final_paths = FinalPaths(transform)
2031
self.__by_parent = None
2032
self._parent_ids = []
2033
self._all_children_cache = {}
2034
self._path2trans_id_cache = {}
2035
self._final_name_cache = {}
2036
self._iter_changes_cache = dict((c.file_id, c) for c in
2037
self._transform.iter_changes())
2039
def _content_change(self, file_id):
2040
"""Return True if the content of this file changed"""
2041
changes = self._iter_changes_cache.get(file_id)
2042
return (changes is not None and changes.changed_content)
2044
def _get_repository(self):
2045
repo = getattr(self._transform._tree, '_repository', None)
2047
repo = self._transform._tree.branch.repository
2050
def _iter_parent_trees(self):
2051
for revision_id in self.get_parent_ids():
2053
yield self.revision_tree(revision_id)
2054
except errors.NoSuchRevisionInTree:
2055
yield self._get_repository().revision_tree(revision_id)
2057
def _get_file_revision(self, path, file_id, vf, tree_revision):
2059
(file_id, t.get_file_revision(t.id2path(file_id)))
2060
for t in self._iter_parent_trees()]
2061
vf.add_lines((file_id, tree_revision), parent_keys,
2062
self.get_file_lines(path))
2063
repo = self._get_repository()
2064
base_vf = repo.texts
2065
if base_vf not in vf.fallback_versionedfiles:
2066
vf.fallback_versionedfiles.append(base_vf)
2067
return tree_revision
2069
def _stat_limbo_file(self, trans_id):
2070
name = self._transform._limbo_name(trans_id)
2071
return os.lstat(name)
2074
def _by_parent(self):
2075
if self.__by_parent is None:
2076
self.__by_parent = self._transform.by_parent()
2077
return self.__by_parent
2079
def _comparison_data(self, entry, path):
2080
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2081
if kind == 'missing':
2085
file_id = self._transform.final_file_id(self._path2trans_id(path))
2086
executable = self.is_executable(path)
2087
return kind, executable, None
2089
def is_locked(self):
2092
def lock_read(self):
2093
# Perhaps in theory, this should lock the TreeTransform?
2094
return lock.LogicalLockResult(self.unlock)
2100
def root_inventory(self):
2101
"""This Tree does not use inventory as its backing data."""
2102
raise NotImplementedError(_PreviewTree.root_inventory)
2104
def all_file_ids(self):
2105
tree_ids = set(self._transform._tree.all_file_ids())
2106
tree_ids.difference_update(self._transform.tree_file_id(t)
2107
for t in self._transform._removed_id)
2108
tree_ids.update(viewvalues(self._transform._new_id))
2111
def all_versioned_paths(self):
2112
tree_paths = set(self._transform._tree.all_versioned_paths())
2114
tree_paths.difference_update(
2115
self._transform.trans_id_tree_path(t)
2116
for t in self._transform._removed_id)
2119
self._final_paths._determine_path(t)
2120
for t in self._transform._new_id)
2124
def _path2trans_id(self, path):
2125
# We must not use None here, because that is a valid value to store.
2126
trans_id = self._path2trans_id_cache.get(path, object)
2127
if trans_id is not object:
2129
segments = splitpath(path)
2130
cur_parent = self._transform.root
2131
for cur_segment in segments:
2132
for child in self._all_children(cur_parent):
2133
final_name = self._final_name_cache.get(child)
2134
if final_name is None:
2135
final_name = self._transform.final_name(child)
2136
self._final_name_cache[child] = final_name
2137
if final_name == cur_segment:
2141
self._path2trans_id_cache[path] = None
2143
self._path2trans_id_cache[path] = cur_parent
2146
def path2id(self, path):
2147
if isinstance(path, list):
2150
path = osutils.pathjoin(*path)
2151
return self._transform.final_file_id(self._path2trans_id(path))
2153
def id2path(self, file_id):
2154
trans_id = self._transform.trans_id_file_id(file_id)
2156
return self._final_paths._determine_path(trans_id)
2158
raise errors.NoSuchId(self, file_id)
2160
def _all_children(self, trans_id):
2161
children = self._all_children_cache.get(trans_id)
2162
if children is not None:
2164
children = set(self._transform.iter_tree_children(trans_id))
2165
# children in the _new_parent set are provided by _by_parent.
2166
children.difference_update(self._transform._new_parent)
2167
children.update(self._by_parent.get(trans_id, []))
2168
self._all_children_cache[trans_id] = children
2172
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2173
in self._transform._tree.extras())
2174
possible_extras.update(self._transform._new_contents)
2175
possible_extras.update(self._transform._removed_id)
2176
for trans_id in possible_extras:
2177
if self._transform.final_file_id(trans_id) is None:
2178
yield self._final_paths._determine_path(trans_id)
2180
def _make_inv_entries(self, ordered_entries, specific_files=None):
2181
for trans_id, parent_file_id in ordered_entries:
2182
file_id = self._transform.final_file_id(trans_id)
2185
if (specific_files is not None
2186
and self._final_paths.get_path(trans_id) not in specific_files):
2188
kind = self._transform.final_kind(trans_id)
2190
kind = self._transform._tree.stored_kind(
2191
self._transform._tree.id2path(file_id))
2192
new_entry = inventory.make_entry(
2194
self._transform.final_name(trans_id),
2195
parent_file_id, file_id)
2196
yield new_entry, trans_id
2198
def _list_files_by_dir(self):
2199
todo = [ROOT_PARENT]
2201
while len(todo) > 0:
2203
parent_file_id = self._transform.final_file_id(parent)
2204
children = list(self._all_children(parent))
2205
paths = dict(zip(children, self._final_paths.get_paths(children)))
2206
children.sort(key=paths.get)
2207
todo.extend(reversed(children))
2208
for trans_id in children:
2209
ordered_ids.append((trans_id, parent_file_id))
2212
def iter_child_entries(self, path):
2213
trans_id = self._path2trans_id(path)
2214
if trans_id is None:
2215
raise errors.NoSuchFile(path)
2216
todo = [(child_trans_id, trans_id) for child_trans_id in
2217
self._all_children(trans_id)]
2218
for entry, trans_id in self._make_inv_entries(todo):
2221
def iter_entries_by_dir(self, specific_files=None, recurse_nested=False):
2223
raise NotImplementedError(
2224
'follow tree references not yet supported')
2226
# This may not be a maximally efficient implementation, but it is
2227
# reasonably straightforward. An implementation that grafts the
2228
# TreeTransform changes onto the tree's iter_entries_by_dir results
2229
# might be more efficient, but requires tricky inferences about stack
2231
ordered_ids = self._list_files_by_dir()
2232
for entry, trans_id in self._make_inv_entries(ordered_ids,
2234
yield self._final_paths.get_path(trans_id), entry
2236
def _iter_entries_for_dir(self, dir_path):
2237
"""Return path, entry for items in a directory without recursing down."""
2239
dir_trans_id = self._path2trans_id(dir_path)
2240
dir_id = self._transform.final_file_id(dir_trans_id)
2241
for child_trans_id in self._all_children(dir_trans_id):
2242
ordered_ids.append((child_trans_id, dir_id))
2244
for entry, trans_id in self._make_inv_entries(ordered_ids):
2245
path_entries.append((self._final_paths.get_path(trans_id), entry))
2249
def list_files(self, include_root=False, from_dir=None, recursive=True,
2250
recurse_nested=False):
2251
"""See WorkingTree.list_files."""
2253
raise NotImplementedError(
2254
'follow tree references not yet supported')
2256
# XXX This should behave like WorkingTree.list_files, but is really
2257
# more like RevisionTree.list_files.
2263
prefix = from_dir + '/'
2264
entries = self.iter_entries_by_dir()
2265
for path, entry in entries:
2266
if entry.name == '' and not include_root:
2269
if not path.startswith(prefix):
2271
path = path[len(prefix):]
2272
yield path, 'V', entry.kind, entry
2274
if from_dir is None and include_root is True:
2275
root_entry = inventory.make_entry(
2276
'directory', '', ROOT_PARENT, self.path2id(''))
2277
yield '', 'V', 'directory', root_entry
2278
entries = self._iter_entries_for_dir(from_dir or '')
2279
for path, entry in entries:
2280
yield path, 'V', entry.kind, entry
2282
def kind(self, path):
2283
trans_id = self._path2trans_id(path)
2284
if trans_id is None:
2285
raise errors.NoSuchFile(path)
2286
return self._transform.final_kind(trans_id)
2288
def stored_kind(self, path):
2289
trans_id = self._path2trans_id(path)
2290
if trans_id is None:
2291
raise errors.NoSuchFile(path)
2293
return self._transform._new_contents[trans_id]
2295
return self._transform._tree.stored_kind(path)
2297
def get_file_mtime(self, path):
2298
"""See Tree.get_file_mtime"""
2299
file_id = self.path2id(path)
2301
raise errors.NoSuchFile(path)
2302
if not self._content_change(file_id):
2303
return self._transform._tree.get_file_mtime(
2304
self._transform._tree.id2path(file_id))
2305
trans_id = self._path2trans_id(path)
2306
return self._stat_limbo_file(trans_id).st_mtime
2308
def get_file_size(self, path):
2309
"""See Tree.get_file_size"""
2310
trans_id = self._path2trans_id(path)
2311
if trans_id is None:
2312
raise errors.NoSuchFile(path)
2313
kind = self._transform.final_kind(trans_id)
2316
if trans_id in self._transform._new_contents:
2317
return self._stat_limbo_file(trans_id).st_size
2318
if self.kind(path) == 'file':
2319
return self._transform._tree.get_file_size(path)
2323
def get_file_verifier(self, path, stat_value=None):
2324
trans_id = self._path2trans_id(path)
2325
if trans_id is None:
2326
raise errors.NoSuchFile(path)
2327
kind = self._transform._new_contents.get(trans_id)
2329
return self._transform._tree.get_file_verifier(path)
2331
with self.get_file(path) as fileobj:
2332
return ("SHA1", sha_file(fileobj))
2334
def get_file_sha1(self, path, stat_value=None):
2335
trans_id = self._path2trans_id(path)
2336
if trans_id is None:
2337
raise errors.NoSuchFile(path)
2338
kind = self._transform._new_contents.get(trans_id)
2340
return self._transform._tree.get_file_sha1(path)
2342
with self.get_file(path) as fileobj:
2343
return sha_file(fileobj)
2345
def is_executable(self, path):
2346
trans_id = self._path2trans_id(path)
2347
if trans_id is None:
2350
return self._transform._new_executability[trans_id]
2353
return self._transform._tree.is_executable(path)
2354
except OSError as e:
2355
if e.errno == errno.ENOENT:
2358
except errors.NoSuchFile:
2361
def has_filename(self, path):
2362
trans_id = self._path2trans_id(path)
2363
if trans_id in self._transform._new_contents:
2365
elif trans_id in self._transform._removed_contents:
2368
return self._transform._tree.has_filename(path)
2370
def path_content_summary(self, path):
2371
trans_id = self._path2trans_id(path)
2372
tt = self._transform
2373
tree_path = tt._tree_id_paths.get(trans_id)
2374
kind = tt._new_contents.get(trans_id)
2376
if tree_path is None or trans_id in tt._removed_contents:
2377
return 'missing', None, None, None
2378
summary = tt._tree.path_content_summary(tree_path)
2379
kind, size, executable, link_or_sha1 = summary
2382
limbo_name = tt._limbo_name(trans_id)
2383
if trans_id in tt._new_reference_revision:
2384
kind = 'tree-reference'
2386
statval = os.lstat(limbo_name)
2387
size = statval.st_size
2388
if not tt._limbo_supports_executable():
2391
executable = statval.st_mode & S_IEXEC
2395
if kind == 'symlink':
2396
link_or_sha1 = os.readlink(limbo_name)
2397
if not isinstance(link_or_sha1, text_type):
2398
link_or_sha1 = link_or_sha1.decode(osutils._fs_enc)
2399
executable = tt._new_executability.get(trans_id, executable)
2400
return kind, size, executable, link_or_sha1
2402
def iter_changes(self, from_tree, include_unchanged=False,
2403
specific_files=None, pb=None, extra_trees=None,
2404
require_versioned=True, want_unversioned=False):
2405
"""See InterTree.iter_changes.
2407
This has a fast path that is only used when the from_tree matches
2408
the transform tree, and no fancy options are supplied.
2410
if (from_tree is not self._transform._tree or include_unchanged
2411
or specific_files or want_unversioned):
2412
return tree.InterTree(from_tree, self).iter_changes(
2413
include_unchanged=include_unchanged,
2414
specific_files=specific_files,
2416
extra_trees=extra_trees,
2417
require_versioned=require_versioned,
2418
want_unversioned=want_unversioned)
2419
if want_unversioned:
2420
raise ValueError('want_unversioned is not supported')
2421
return self._transform.iter_changes()
2423
def get_file(self, path):
2424
"""See Tree.get_file"""
2425
file_id = self.path2id(path)
2426
if not self._content_change(file_id):
2427
return self._transform._tree.get_file(path)
2428
trans_id = self._path2trans_id(path)
2429
name = self._transform._limbo_name(trans_id)
2430
return open(name, 'rb')
2432
def get_file_with_stat(self, path):
2433
return self.get_file(path), None
2435
def annotate_iter(self, path,
2436
default_revision=_mod_revision.CURRENT_REVISION):
2437
file_id = self.path2id(path)
2438
changes = self._iter_changes_cache.get(file_id)
2442
changed_content, versioned, kind = (
2443
changes.changed_content, changes.versioned, changes.kind)
2446
get_old = (kind[0] == 'file' and versioned[0])
2448
old_annotation = self._transform._tree.annotate_iter(
2449
path, default_revision=default_revision)
2453
return old_annotation
2454
if not changed_content:
2455
return old_annotation
2456
# TODO: This is doing something similar to what WT.annotate_iter is
2457
# doing, however it fails slightly because it doesn't know what
2458
# the *other* revision_id is, so it doesn't know how to give the
2459
# other as the origin for some lines, they all get
2460
# 'default_revision'
2461
# It would be nice to be able to use the new Annotator based
2462
# approach, as well.
2463
return annotate.reannotate([old_annotation],
2464
self.get_file(path).readlines(),
2467
def get_symlink_target(self, path):
2468
"""See Tree.get_symlink_target"""
2469
file_id = self.path2id(path)
2470
if not self._content_change(file_id):
2471
return self._transform._tree.get_symlink_target(path)
2472
trans_id = self._path2trans_id(path)
2473
name = self._transform._limbo_name(trans_id)
2474
return osutils.readlink(name)
2476
def walkdirs(self, prefix=''):
2477
pending = [self._transform.root]
2478
while len(pending) > 0:
2479
parent_id = pending.pop()
2482
prefix = prefix.rstrip('/')
2483
parent_path = self._final_paths.get_path(parent_id)
2484
parent_file_id = self._transform.final_file_id(parent_id)
2485
for child_id in self._all_children(parent_id):
2486
path_from_root = self._final_paths.get_path(child_id)
2487
basename = self._transform.final_name(child_id)
2488
file_id = self._transform.final_file_id(child_id)
2489
kind = self._transform.final_kind(child_id)
2490
if kind is not None:
2491
versioned_kind = kind
2494
versioned_kind = self._transform._tree.stored_kind(
2495
self._transform._tree.id2path(file_id))
2496
if versioned_kind == 'directory':
2497
subdirs.append(child_id)
2498
children.append((path_from_root, basename, kind, None,
2499
file_id, versioned_kind))
2501
if parent_path.startswith(prefix):
2502
yield (parent_path, parent_file_id), children
2503
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2506
def get_parent_ids(self):
2507
return self._parent_ids
2509
def set_parent_ids(self, parent_ids):
2510
self._parent_ids = parent_ids
2512
def get_revision_tree(self, revision_id):
2513
return self._transform._tree.get_revision_tree(revision_id)
2516
def joinpath(parent, child):
2517
"""Join tree-relative paths, handling the tree root specially"""
2518
if parent is None or parent == "":
2521
return pathjoin(parent, child)
2524
class FinalPaths(object):
2525
"""Make path calculation cheap by memoizing paths.
2527
The underlying tree must not be manipulated between calls, or else
2528
the results will likely be incorrect.
2531
def __init__(self, transform):
2532
object.__init__(self)
2533
self._known_paths = {}
2534
self.transform = transform
2536
def _determine_path(self, trans_id):
2537
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2539
name = self.transform.final_name(trans_id)
2540
parent_id = self.transform.final_parent(trans_id)
2541
if parent_id == self.transform.root:
2544
return pathjoin(self.get_path(parent_id), name)
2546
def get_path(self, trans_id):
2547
"""Find the final path associated with a trans_id"""
2548
if trans_id not in self._known_paths:
2549
self._known_paths[trans_id] = self._determine_path(trans_id)
2550
return self._known_paths[trans_id]
2552
def get_paths(self, trans_ids):
2553
return [(self.get_path(t), t) for t in trans_ids]
2556
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2557
delta_from_tree=False):
2558
"""Create working tree for a branch, using a TreeTransform.
2560
This function should be used on empty trees, having a tree root at most.
2561
(see merge and revert functionality for working with existing trees)
2563
Existing files are handled like so:
2565
- Existing bzrdirs take precedence over creating new items. They are
2566
created as '%s.diverted' % name.
2567
- Otherwise, if the content on disk matches the content we are building,
2568
it is silently replaced.
2569
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2571
:param tree: The tree to convert wt into a copy of
2572
:param wt: The working tree that files will be placed into
2573
:param accelerator_tree: A tree which can be used for retrieving file
2574
contents more quickly than tree itself, i.e. a workingtree. tree
2575
will be used for cases where accelerator_tree's content is different.
2576
:param hardlink: If true, hard-link files to accelerator_tree, where
2577
possible. accelerator_tree must implement abspath, i.e. be a
2579
:param delta_from_tree: If true, build_tree may use the input Tree to
2580
generate the inventory delta.
2582
with cleanup.ExitStack() as exit_stack:
2583
exit_stack.enter_context(wt.lock_tree_write())
2584
exit_stack.enter_context(tree.lock_read())
2585
if accelerator_tree is not None:
2586
exit_stack.enter_context(accelerator_tree.lock_read())
2587
return _build_tree(tree, wt, accelerator_tree, hardlink,
2591
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2592
"""See build_tree."""
2593
for num, _unused in enumerate(wt.all_versioned_paths()):
2594
if num > 0: # more than just a root
2595
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2597
top_pb = ui.ui_factory.nested_progress_bar()
2598
pp = ProgressPhase("Build phase", 2, top_pb)
2599
if tree.path2id('') is not None:
2600
# This is kind of a hack: we should be altering the root
2601
# as part of the regular tree shape diff logic.
2602
# The conditional test here is to avoid doing an
2603
# expensive operation (flush) every time the root id
2604
# is set within the tree, nor setting the root and thus
2605
# marking the tree as dirty, because we use two different
2606
# idioms here: tree interfaces and inventory interfaces.
2607
if wt.path2id('') != tree.path2id(''):
2608
wt.set_root_id(tree.path2id(''))
2610
tt = wt.get_transform()
2614
file_trans_id[wt.path2id('')] = tt.trans_id_tree_path('')
2615
with ui.ui_factory.nested_progress_bar() as pb:
2616
deferred_contents = []
2618
total = len(tree.all_versioned_paths())
2620
precomputed_delta = []
2622
precomputed_delta = None
2623
# Check if tree inventory has content. If so, we populate
2624
# existing_files with the directory content. If there are no
2625
# entries we skip populating existing_files as its not used.
2626
# This improves performance and unncessary work on large
2627
# directory trees. (#501307)
2629
existing_files = set()
2630
for dir, files in wt.walkdirs():
2631
existing_files.update(f[0] for f in files)
2632
for num, (tree_path, entry) in \
2633
enumerate(tree.iter_entries_by_dir()):
2634
pb.update(gettext("Building tree"), num
2635
- len(deferred_contents), total)
2636
if entry.parent_id is None:
2639
file_id = entry.file_id
2641
precomputed_delta.append((None, tree_path, file_id, entry))
2642
if tree_path in existing_files:
2643
target_path = wt.abspath(tree_path)
2644
kind = file_kind(target_path)
2645
if kind == "directory":
2647
controldir.ControlDir.open(target_path)
2648
except errors.NotBranchError:
2652
if (file_id not in divert
2654
tree, entry, tree_path, kind, target_path)):
2655
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2656
if kind == 'directory':
2658
parent_id = file_trans_id[entry.parent_id]
2659
if entry.kind == 'file':
2660
# We *almost* replicate new_by_entry, so that we can defer
2661
# getting the file text, and get them all at once.
2662
trans_id = tt.create_path(entry.name, parent_id)
2663
file_trans_id[file_id] = trans_id
2664
tt.version_file(file_id, trans_id)
2665
executable = tree.is_executable(tree_path)
2667
tt.set_executability(executable, trans_id)
2668
trans_data = (trans_id, file_id,
2669
tree_path, entry.text_sha1)
2670
deferred_contents.append((tree_path, trans_data))
2672
file_trans_id[file_id] = new_by_entry(
2673
tree_path, tt, entry, parent_id, tree)
2675
new_trans_id = file_trans_id[file_id]
2676
old_parent = tt.trans_id_tree_path(tree_path)
2677
_reparent_children(tt, old_parent, new_trans_id)
2678
offset = num + 1 - len(deferred_contents)
2679
_create_files(tt, tree, deferred_contents, pb, offset,
2680
accelerator_tree, hardlink)
2682
divert_trans = set(file_trans_id[f] for f in divert)
2685
return resolve_checkout(t, c, divert_trans)
2686
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2687
if len(raw_conflicts) > 0:
2688
precomputed_delta = None
2689
conflicts = cook_conflicts(raw_conflicts, tt)
2690
for conflict in conflicts:
2691
trace.warning(text_type(conflict))
2693
wt.add_conflicts(conflicts)
2694
except errors.UnsupportedOperation:
2696
result = tt.apply(no_conflicts=True,
2697
precomputed_delta=precomputed_delta)
2704
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2706
total = len(desired_files) + offset
2708
if accelerator_tree is None:
2709
new_desired_files = desired_files
2711
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2713
change.path for change in iter
2714
if not (change.changed_content or change.executable[0] != change.executable[1])]
2715
if accelerator_tree.supports_content_filtering():
2716
unchanged = [(tp, ap) for (tp, ap) in unchanged
2717
if not next(accelerator_tree.iter_search_rules([ap]))]
2718
unchanged = dict(unchanged)
2719
new_desired_files = []
2721
for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
2722
accelerator_path = unchanged.get(tree_path)
2723
if accelerator_path is None:
2724
new_desired_files.append((tree_path,
2725
(trans_id, file_id, tree_path, text_sha1)))
2727
pb.update(gettext('Adding file contents'), count + offset, total)
2729
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2732
with accelerator_tree.get_file(accelerator_path) as f:
2733
chunks = osutils.file_iterator(f)
2734
if wt.supports_content_filtering():
2735
filters = wt._content_filter_stack(tree_path)
2736
chunks = filtered_output_bytes(chunks, filters,
2737
ContentFilterContext(tree_path, tree))
2738
tt.create_file(chunks, trans_id, sha1=text_sha1)
2741
for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
2742
tree.iter_files_bytes(new_desired_files)):
2743
if wt.supports_content_filtering():
2744
filters = wt._content_filter_stack(tree_path)
2745
contents = filtered_output_bytes(contents, filters,
2746
ContentFilterContext(tree_path, tree))
2747
tt.create_file(contents, trans_id, sha1=text_sha1)
2748
pb.update(gettext('Adding file contents'), count + offset, total)
2751
def _reparent_children(tt, old_parent, new_parent):
2752
for child in tt.iter_tree_children(old_parent):
2753
tt.adjust_path(tt.final_name(child), new_parent, child)
2756
def _reparent_transform_children(tt, old_parent, new_parent):
2757
by_parent = tt.by_parent()
2758
for child in by_parent[old_parent]:
2759
tt.adjust_path(tt.final_name(child), new_parent, child)
2760
return by_parent[old_parent]
2763
def _content_match(tree, entry, tree_path, kind, target_path):
2764
if entry.kind != kind:
2766
if entry.kind == "directory":
2768
if entry.kind == "file":
2769
with open(target_path, 'rb') as f1, \
2770
tree.get_file(tree_path) as f2:
2771
if osutils.compare_files(f1, f2):
2773
elif entry.kind == "symlink":
2774
if tree.get_symlink_target(tree_path) == os.readlink(target_path):
2779
def resolve_checkout(tt, conflicts, divert):
2780
new_conflicts = set()
2781
for c_type, conflict in ((c[0], c) for c in conflicts):
2782
# Anything but a 'duplicate' would indicate programmer error
2783
if c_type != 'duplicate':
2784
raise AssertionError(c_type)
2785
# Now figure out which is new and which is old
2786
if tt.new_contents(conflict[1]):
2787
new_file = conflict[1]
2788
old_file = conflict[2]
2790
new_file = conflict[2]
2791
old_file = conflict[1]
2793
# We should only get here if the conflict wasn't completely
2795
final_parent = tt.final_parent(old_file)
2796
if new_file in divert:
2797
new_name = tt.final_name(old_file) + '.diverted'
2798
tt.adjust_path(new_name, final_parent, new_file)
2799
new_conflicts.add((c_type, 'Diverted to',
2800
new_file, old_file))
2802
new_name = tt.final_name(old_file) + '.moved'
2803
tt.adjust_path(new_name, final_parent, old_file)
2804
new_conflicts.add((c_type, 'Moved existing file to',
2805
old_file, new_file))
2806
return new_conflicts
2809
def new_by_entry(path, tt, entry, parent_id, tree):
2810
"""Create a new file according to its inventory entry"""
2814
with tree.get_file(path) as f:
2815
executable = tree.is_executable(path)
2817
name, parent_id, osutils.file_iterator(f), entry.file_id,
2819
elif kind in ('directory', 'tree-reference'):
2820
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2821
if kind == 'tree-reference':
2822
tt.set_tree_reference(entry.reference_revision, trans_id)
2824
elif kind == 'symlink':
2825
target = tree.get_symlink_target(path)
2826
return tt.new_symlink(name, parent_id, target, entry.file_id)
2828
raise errors.BadFileKindError(name, kind)
2831
def create_from_tree(tt, trans_id, tree, path, chunks=None,
2832
filter_tree_path=None):
2833
"""Create new file contents according to tree contents.
2835
:param filter_tree_path: the tree path to use to lookup
2836
content filters to apply to the bytes output in the working tree.
2837
This only applies if the working tree supports content filtering.
2839
kind = tree.kind(path)
2840
if kind == 'directory':
2841
tt.create_directory(trans_id)
2842
elif kind == "file":
2844
f = tree.get_file(path)
2845
chunks = osutils.file_iterator(f)
2850
if wt.supports_content_filtering() and filter_tree_path is not None:
2851
filters = wt._content_filter_stack(filter_tree_path)
2852
chunks = filtered_output_bytes(
2854
ContentFilterContext(filter_tree_path, tree))
2855
tt.create_file(chunks, trans_id)
2859
elif kind == "symlink":
2860
tt.create_symlink(tree.get_symlink_target(path), trans_id)
2862
raise AssertionError('Unknown kind %r' % kind)
2865
def create_entry_executability(tt, entry, trans_id):
2866
"""Set the executability of a trans_id according to an inventory entry"""
2867
if entry.kind == "file":
2868
tt.set_executability(entry.executable, trans_id)
2871
def revert(working_tree, target_tree, filenames, backups=False,
2872
pb=None, change_reporter=None):
2873
"""Revert a working tree's contents to those of a target tree."""
2874
pb = ui.ui_factory.nested_progress_bar()
2876
with target_tree.lock_read(), working_tree.get_transform(pb) as tt:
2877
pp = ProgressPhase("Revert phase", 3, pb)
2878
conflicts, merge_modified = _prepare_revert_transform(
2879
working_tree, target_tree, tt, filenames, backups, pp)
2881
change_reporter = delta._ChangeReporter(
2882
unversioned_filter=working_tree.is_ignored)
2883
delta.report_changes(tt.iter_changes(), change_reporter)
2884
for conflict in conflicts:
2885
trace.warning(text_type(conflict))
2888
if working_tree.supports_merge_modified():
2889
working_tree.set_merge_modified(merge_modified)
2895
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2896
backups, pp, basis_tree=None,
2897
merge_modified=None):
2898
with ui.ui_factory.nested_progress_bar() as child_pb:
2899
if merge_modified is None:
2900
merge_modified = working_tree.merge_modified()
2901
merge_modified = _alter_files(working_tree, target_tree, tt,
2902
child_pb, filenames, backups,
2903
merge_modified, basis_tree)
2904
with ui.ui_factory.nested_progress_bar() as child_pb:
2905
raw_conflicts = resolve_conflicts(
2906
tt, child_pb, lambda t, c: conflict_pass(t, c, target_tree))
2907
conflicts = cook_conflicts(raw_conflicts, tt)
2908
return conflicts, merge_modified
2911
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2912
backups, merge_modified, basis_tree=None):
2913
if basis_tree is not None:
2914
basis_tree.lock_read()
2915
# We ask the working_tree for its changes relative to the target, rather
2916
# than the target changes relative to the working tree. Because WT4 has an
2917
# optimizer to compare itself to a target, but no optimizer for the
2919
change_list = working_tree.iter_changes(
2920
target_tree, specific_files=specific_files, pb=pb)
2921
if not target_tree.is_versioned(u''):
2927
for id_num, change in enumerate(change_list):
2928
file_id = change.file_id
2929
target_path, wt_path = change.path
2930
target_versioned, wt_versioned = change.versioned
2931
target_parent, wt_parent = change.parent_id
2932
target_name, wt_name = change.name
2933
target_kind, wt_kind = change.kind
2934
target_executable, wt_executable = change.executable
2935
if skip_root and wt_parent is None:
2937
trans_id = tt.trans_id_file_id(file_id)
2939
if change.changed_content:
2940
keep_content = False
2941
if wt_kind == 'file' and (backups or target_kind is None):
2942
wt_sha1 = working_tree.get_file_sha1(wt_path)
2943
if merge_modified.get(wt_path) != wt_sha1:
2944
# acquire the basis tree lazily to prevent the
2945
# expense of accessing it when it's not needed ?
2946
# (Guessing, RBC, 200702)
2947
if basis_tree is None:
2948
basis_tree = working_tree.basis_tree()
2949
basis_tree.lock_read()
2950
basis_path = find_previous_path(
2951
working_tree, basis_tree, wt_path)
2952
if basis_path is None:
2953
if target_kind is None and not target_versioned:
2956
if wt_sha1 != basis_tree.get_file_sha1(basis_path):
2958
if wt_kind is not None:
2959
if not keep_content:
2960
tt.delete_contents(trans_id)
2961
elif target_kind is not None:
2962
parent_trans_id = tt.trans_id_file_id(wt_parent)
2963
backup_name = tt._available_backup_name(
2964
wt_name, parent_trans_id)
2965
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2966
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2967
if wt_versioned and target_versioned:
2968
tt.unversion_file(trans_id)
2969
tt.version_file(file_id, new_trans_id)
2970
# New contents should have the same unix perms as old
2973
trans_id = new_trans_id
2974
if target_kind in ('directory', 'tree-reference'):
2975
tt.create_directory(trans_id)
2976
if target_kind == 'tree-reference':
2977
revision = target_tree.get_reference_revision(
2979
tt.set_tree_reference(revision, trans_id)
2980
elif target_kind == 'symlink':
2981
tt.create_symlink(target_tree.get_symlink_target(
2982
target_path), trans_id)
2983
elif target_kind == 'file':
2984
deferred_files.append(
2985
(target_path, (trans_id, mode_id, file_id)))
2986
if basis_tree is None:
2987
basis_tree = working_tree.basis_tree()
2988
basis_tree.lock_read()
2989
new_sha1 = target_tree.get_file_sha1(target_path)
2990
basis_path = find_previous_path(target_tree, basis_tree, target_path)
2991
if (basis_path is not None and
2992
new_sha1 == basis_tree.get_file_sha1(basis_path)):
2993
# If the new contents of the file match what is in basis,
2994
# then there is no need to store in merge_modified.
2995
if basis_path in merge_modified:
2996
del merge_modified[basis_path]
2998
merge_modified[target_path] = new_sha1
3000
# preserve the execute bit when backing up
3001
if keep_content and wt_executable == target_executable:
3002
tt.set_executability(target_executable, trans_id)
3003
elif target_kind is not None:
3004
raise AssertionError(target_kind)
3005
if not wt_versioned and target_versioned:
3006
tt.version_file(file_id, trans_id)
3007
if wt_versioned and not target_versioned:
3008
tt.unversion_file(trans_id)
3009
if (target_name is not None
3010
and (wt_name != target_name or wt_parent != target_parent)):
3011
if target_name == '' and target_parent is None:
3012
parent_trans = ROOT_PARENT
3014
parent_trans = tt.trans_id_file_id(target_parent)
3015
if wt_parent is None and wt_versioned:
3016
tt.adjust_root_path(target_name, parent_trans)
3018
tt.adjust_path(target_name, parent_trans, trans_id)
3019
if wt_executable != target_executable and target_kind == "file":
3020
tt.set_executability(target_executable, trans_id)
3021
if working_tree.supports_content_filtering():
3022
for (trans_id, mode_id, file_id), bytes in (
3023
target_tree.iter_files_bytes(deferred_files)):
3024
# We're reverting a tree to the target tree so using the
3025
# target tree to find the file path seems the best choice
3026
# here IMO - Ian C 27/Oct/2009
3027
filter_tree_path = target_tree.id2path(file_id)
3028
filters = working_tree._content_filter_stack(filter_tree_path)
3029
bytes = filtered_output_bytes(
3031
ContentFilterContext(filter_tree_path, working_tree))
3032
tt.create_file(bytes, trans_id, mode_id)
3034
for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
3036
tt.create_file(bytes, trans_id, mode_id)
3037
tt.fixup_new_roots()
3039
if basis_tree is not None:
3041
return merge_modified
3044
def resolve_conflicts(tt, pb=None, pass_func=None):
3045
"""Make many conflict-resolution attempts, but die if they fail"""
3046
if pass_func is None:
3047
pass_func = conflict_pass
3048
new_conflicts = set()
3049
with ui.ui_factory.nested_progress_bar() as pb:
3051
pb.update(gettext('Resolution pass'), n + 1, 10)
3052
conflicts = tt.find_conflicts()
3053
if len(conflicts) == 0:
3054
return new_conflicts
3055
new_conflicts.update(pass_func(tt, conflicts))
3056
raise MalformedTransform(conflicts=conflicts)
3059
def conflict_pass(tt, conflicts, path_tree=None):
3060
"""Resolve some classes of conflicts.
3062
:param tt: The transform to resolve conflicts in
3063
:param conflicts: The conflicts to resolve
3064
:param path_tree: A Tree to get supplemental paths from
3066
new_conflicts = set()
3067
for c_type, conflict in ((c[0], c) for c in conflicts):
3068
if c_type == 'duplicate id':
3069
tt.unversion_file(conflict[1])
3070
new_conflicts.add((c_type, 'Unversioned existing file',
3071
conflict[1], conflict[2], ))
3072
elif c_type == 'duplicate':
3073
# files that were renamed take precedence
3074
final_parent = tt.final_parent(conflict[1])
3075
if tt.path_changed(conflict[1]):
3076
existing_file, new_file = conflict[2], conflict[1]
3078
existing_file, new_file = conflict[1], conflict[2]
3079
new_name = tt.final_name(existing_file) + '.moved'
3080
tt.adjust_path(new_name, final_parent, existing_file)
3081
new_conflicts.add((c_type, 'Moved existing file to',
3082
existing_file, new_file))
3083
elif c_type == 'parent loop':
3084
# break the loop by undoing one of the ops that caused the loop
3086
while not tt.path_changed(cur):
3087
cur = tt.final_parent(cur)
3088
new_conflicts.add((c_type, 'Cancelled move', cur,
3089
tt.final_parent(cur),))
3090
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3092
elif c_type == 'missing parent':
3093
trans_id = conflict[1]
3094
if trans_id in tt._removed_contents:
3095
cancel_deletion = True
3096
orphans = tt._get_potential_orphans(trans_id)
3098
cancel_deletion = False
3099
# All children are orphans
3102
tt.new_orphan(o, trans_id)
3103
except OrphaningError:
3104
# Something bad happened so we cancel the directory
3105
# deletion which will leave it in place with a
3106
# conflict. The user can deal with it from there.
3107
# Note that this also catch the case where we don't
3108
# want to create orphans and leave the directory in
3110
cancel_deletion = True
3113
# Cancel the directory deletion
3114
tt.cancel_deletion(trans_id)
3115
new_conflicts.add(('deleting parent', 'Not deleting',
3120
tt.final_name(trans_id)
3122
if path_tree is not None:
3123
file_id = tt.final_file_id(trans_id)
3125
file_id = tt.inactive_file_id(trans_id)
3126
_, entry = next(path_tree.iter_entries_by_dir(
3127
specific_files=[path_tree.id2path(file_id)]))
3128
# special-case the other tree root (move its
3129
# children to current root)
3130
if entry.parent_id is None:
3132
moved = _reparent_transform_children(
3133
tt, trans_id, tt.root)
3135
new_conflicts.add((c_type, 'Moved to root',
3138
parent_trans_id = tt.trans_id_file_id(
3140
tt.adjust_path(entry.name, parent_trans_id,
3143
tt.create_directory(trans_id)
3144
new_conflicts.add((c_type, 'Created directory', trans_id))
3145
elif c_type == 'unversioned parent':
3146
file_id = tt.inactive_file_id(conflict[1])
3147
# special-case the other tree root (move its children instead)
3148
if path_tree and path_tree.path2id('') == file_id:
3149
# This is the root entry, skip it
3151
tt.version_file(file_id, conflict[1])
3152
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3153
elif c_type == 'non-directory parent':
3154
parent_id = conflict[1]
3155
parent_parent = tt.final_parent(parent_id)
3156
parent_name = tt.final_name(parent_id)
3157
parent_file_id = tt.final_file_id(parent_id)
3158
new_parent_id = tt.new_directory(parent_name + '.new',
3159
parent_parent, parent_file_id)
3160
_reparent_transform_children(tt, parent_id, new_parent_id)
3161
if parent_file_id is not None:
3162
tt.unversion_file(parent_id)
3163
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3164
elif c_type == 'versioning no contents':
3165
tt.cancel_versioning(conflict[1])
3166
return new_conflicts
3169
def cook_conflicts(raw_conflicts, tt):
3170
"""Generate a list of cooked conflicts, sorted by file path"""
3171
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3172
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3175
def iter_cook_conflicts(raw_conflicts, tt):
3177
for conflict in raw_conflicts:
3178
c_type = conflict[0]
3179
action = conflict[1]
3180
modified_path = fp.get_path(conflict[2])
3181
modified_id = tt.final_file_id(conflict[2])
3182
if len(conflict) == 3:
3183
yield conflicts.Conflict.factory(
3184
c_type, action=action, path=modified_path, file_id=modified_id)
3187
conflicting_path = fp.get_path(conflict[3])
3188
conflicting_id = tt.final_file_id(conflict[3])
3189
yield conflicts.Conflict.factory(
3190
c_type, action=action, path=modified_path,
3191
file_id=modified_id,
3192
conflict_path=conflicting_path,
3193
conflict_file_id=conflicting_id)
3196
class _FileMover(object):
3197
"""Moves and deletes files for TreeTransform, tracking operations"""
3200
self.past_renames = []
3201
self.pending_deletions = []
3203
def rename(self, from_, to):
3204
"""Rename a file from one path to another."""
3206
os.rename(from_, to)
3207
except OSError as e:
3208
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3209
raise errors.FileExists(to, str(e))
3210
# normal OSError doesn't include filenames so it's hard to see where
3211
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3212
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3213
self.past_renames.append((from_, to))
3215
def pre_delete(self, from_, to):
3216
"""Rename a file out of the way and mark it for deletion.
3218
Unlike os.unlink, this works equally well for files and directories.
3219
:param from_: The current file path
3220
:param to: A temporary path for the file
3222
self.rename(from_, to)
3223
self.pending_deletions.append(to)
3226
"""Reverse all renames that have been performed"""
3227
for from_, to in reversed(self.past_renames):
3229
os.rename(to, from_)
3230
except OSError as e:
3231
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3232
# after rollback, don't reuse _FileMover
3233
self.past_renames = None
3234
self.pending_deletions = None
3236
def apply_deletions(self):
3237
"""Apply all marked deletions"""
3238
for path in self.pending_deletions:
3240
# after apply_deletions, don't reuse _FileMover
3241
self.past_renames = None
3242
self.pending_deletions = None
3245
def link_tree(target_tree, source_tree):
3246
"""Where possible, hard-link files in a tree to those in another tree.
3248
:param target_tree: Tree to change
3249
:param source_tree: Tree to hard-link from
3251
with target_tree.get_transform() as tt:
3252
for change in target_tree.iter_changes(source_tree, include_unchanged=True):
3253
if change.changed_content:
3255
if change.kind != ('file', 'file'):
3257
if change.executable[0] != change.executable[1]:
3259
trans_id = tt.trans_id_tree_path(change.path[1])
3260
tt.delete_contents(trans_id)
3261
tt.create_hardlink(source_tree.abspath(change.path[0]), trans_id)
added
removed
breezy/transform.py
