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(), """
43
revision as _mod_revision,
47
from breezy.bzr import (
51
from breezy.i18n import gettext
53
from .errors import (DuplicateKey, MalformedTransform,
54
ReusingTransform, CantMoveRoot,
55
ImmortalLimbo, NoFinalPath,
57
from .filters import filtered_output_bytes, ContentFilterContext
58
from .mutabletree import MutableTree
59
from .osutils import (
67
from .progress import ProgressPhase
78
ROOT_PARENT = "root-parent"
81
def unique_add(map, key, value):
83
raise DuplicateKey(key=key)
87
class _TransformResults(object):
88
def __init__(self, modified_paths, rename_count):
90
self.modified_paths = modified_paths
91
self.rename_count = rename_count
94
class TreeTransformBase(object):
95
"""The base class for TreeTransform and its kin."""
97
def __init__(self, tree, pb=None, case_sensitive=True):
100
:param tree: The tree that will be transformed, but not necessarily
103
:param case_sensitive: If True, the target of the transform is
104
case sensitive, not just case preserving.
106
object.__init__(self)
109
# mapping of trans_id -> new basename
111
# mapping of trans_id -> new parent trans_id
112
self._new_parent = {}
113
# mapping of trans_id with new contents -> new file_kind
114
self._new_contents = {}
115
# mapping of trans_id => (sha1 of content, stat_value)
116
self._observed_sha1s = {}
117
# Set of trans_ids whose contents will be removed
118
self._removed_contents = set()
119
# Mapping of trans_id -> new execute-bit value
120
self._new_executability = {}
121
# Mapping of trans_id -> new tree-reference value
122
self._new_reference_revision = {}
123
# Mapping of trans_id -> new file_id
125
# Mapping of old file-id -> trans_id
126
self._non_present_ids = {}
127
# Mapping of new file_id -> trans_id
129
# Set of trans_ids that will be removed
130
self._removed_id = set()
131
# Mapping of path in old tree -> trans_id
132
self._tree_path_ids = {}
133
# Mapping trans_id -> path in old tree
134
self._tree_id_paths = {}
135
# The trans_id that will be used as the tree root
136
if tree.is_versioned(''):
137
self._new_root = self.trans_id_tree_path('')
139
self._new_root = None
140
# Indicator of whether the transform has been applied
144
# Whether the target is case sensitive
145
self._case_sensitive_target = case_sensitive
146
# A counter of how many files have been renamed
147
self.rename_count = 0
150
"""Support Context Manager API."""
153
def __exit__(self, exc_type, exc_val, exc_tb):
154
"""Support Context Manager API."""
158
"""Release the working tree lock, if held.
160
This is required if apply has not been invoked, but can be invoked
163
if self._tree is None:
165
for hook in MutableTree.hooks['post_transform']:
166
hook(self._tree, self)
170
def __get_root(self):
171
return self._new_root
173
root = property(__get_root)
175
def _assign_id(self):
176
"""Produce a new tranform id"""
177
new_id = "new-%s" % self._id_number
181
def create_path(self, name, parent):
182
"""Assign a transaction id to a new path"""
183
trans_id = self._assign_id()
184
unique_add(self._new_name, trans_id, name)
185
unique_add(self._new_parent, trans_id, parent)
188
def adjust_path(self, name, parent, trans_id):
189
"""Change the path that is assigned to a transaction id."""
191
raise ValueError("Parent trans-id may not be None")
192
if trans_id == self._new_root:
194
self._new_name[trans_id] = name
195
self._new_parent[trans_id] = parent
197
def adjust_root_path(self, name, parent):
198
"""Emulate moving the root by moving all children, instead.
200
We do this by undoing the association of root's transaction id with the
201
current tree. This allows us to create a new directory with that
202
transaction id. We unversion the root directory and version the
203
physically new directory, and hope someone versions the tree root
206
old_root = self._new_root
207
old_root_file_id = self.final_file_id(old_root)
208
# force moving all children of root
209
for child_id in self.iter_tree_children(old_root):
210
if child_id != parent:
211
self.adjust_path(self.final_name(child_id),
212
self.final_parent(child_id), child_id)
213
file_id = self.final_file_id(child_id)
214
if file_id is not None:
215
self.unversion_file(child_id)
216
self.version_file(file_id, child_id)
218
# the physical root needs a new transaction id
219
self._tree_path_ids.pop("")
220
self._tree_id_paths.pop(old_root)
221
self._new_root = self.trans_id_tree_path('')
222
if parent == old_root:
223
parent = self._new_root
224
self.adjust_path(name, parent, old_root)
225
self.create_directory(old_root)
226
self.version_file(old_root_file_id, old_root)
227
self.unversion_file(self._new_root)
229
def fixup_new_roots(self):
230
"""Reinterpret requests to change the root directory
232
Instead of creating a root directory, or moving an existing directory,
233
all the attributes and children of the new root are applied to the
234
existing root directory.
236
This means that the old root trans-id becomes obsolete, so it is
237
recommended only to invoke this after the root trans-id has become
241
new_roots = [k for k, v in viewitems(self._new_parent)
243
if len(new_roots) < 1:
245
if len(new_roots) != 1:
246
raise ValueError('A tree cannot have two roots!')
247
if self._new_root is None:
248
self._new_root = new_roots[0]
250
old_new_root = new_roots[0]
251
# unversion the new root's directory.
252
if self.final_kind(self._new_root) is None:
253
file_id = self.final_file_id(old_new_root)
255
file_id = self.final_file_id(self._new_root)
256
if old_new_root in self._new_id:
257
self.cancel_versioning(old_new_root)
259
self.unversion_file(old_new_root)
260
# if, at this stage, root still has an old file_id, zap it so we can
261
# stick a new one in.
262
if (self.tree_file_id(self._new_root) is not None
263
and self._new_root not in self._removed_id):
264
self.unversion_file(self._new_root)
265
if file_id is not None:
266
self.version_file(file_id, self._new_root)
268
# Now move children of new root into old root directory.
269
# Ensure all children are registered with the transaction, but don't
270
# use directly-- some tree children have new parents
271
list(self.iter_tree_children(old_new_root))
272
# Move all children of new root into old root directory.
273
for child in self.by_parent().get(old_new_root, []):
274
self.adjust_path(self.final_name(child), self._new_root, child)
276
# Ensure old_new_root has no directory.
277
if old_new_root in self._new_contents:
278
self.cancel_creation(old_new_root)
280
self.delete_contents(old_new_root)
282
# prevent deletion of root directory.
283
if self._new_root in self._removed_contents:
284
self.cancel_deletion(self._new_root)
286
# destroy path info for old_new_root.
287
del self._new_parent[old_new_root]
288
del self._new_name[old_new_root]
290
def trans_id_file_id(self, file_id):
291
"""Determine or set the transaction id associated with a file ID.
292
A new id is only created for file_ids that were never present. If
293
a transaction has been unversioned, it is deliberately still returned.
294
(this will likely lead to an unversioned parent conflict.)
297
raise ValueError('None is not a valid file id')
298
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
299
return self._r_new_id[file_id]
302
path = self._tree.id2path(file_id)
303
except errors.NoSuchId:
304
if file_id in self._non_present_ids:
305
return self._non_present_ids[file_id]
307
trans_id = self._assign_id()
308
self._non_present_ids[file_id] = trans_id
311
return self.trans_id_tree_path(path)
313
def trans_id_tree_path(self, path):
314
"""Determine (and maybe set) the transaction ID for a tree path."""
315
path = self.canonical_path(path)
316
if path not in self._tree_path_ids:
317
self._tree_path_ids[path] = self._assign_id()
318
self._tree_id_paths[self._tree_path_ids[path]] = path
319
return self._tree_path_ids[path]
321
def get_tree_parent(self, trans_id):
322
"""Determine id of the parent in the tree."""
323
path = self._tree_id_paths[trans_id]
326
return self.trans_id_tree_path(os.path.dirname(path))
328
def delete_contents(self, trans_id):
329
"""Schedule the contents of a path entry for deletion"""
330
kind = self.tree_kind(trans_id)
332
self._removed_contents.add(trans_id)
334
def cancel_deletion(self, trans_id):
335
"""Cancel a scheduled deletion"""
336
self._removed_contents.remove(trans_id)
338
def unversion_file(self, trans_id):
339
"""Schedule a path entry to become unversioned"""
340
self._removed_id.add(trans_id)
342
def delete_versioned(self, trans_id):
343
"""Delete and unversion a versioned file"""
344
self.delete_contents(trans_id)
345
self.unversion_file(trans_id)
347
def set_executability(self, executability, trans_id):
348
"""Schedule setting of the 'execute' bit
349
To unschedule, set to None
351
if executability is None:
352
del self._new_executability[trans_id]
354
unique_add(self._new_executability, trans_id, executability)
356
def set_tree_reference(self, revision_id, trans_id):
357
"""Set the reference associated with a directory"""
358
unique_add(self._new_reference_revision, trans_id, revision_id)
360
def version_file(self, file_id, trans_id):
361
"""Schedule a file to become versioned."""
364
unique_add(self._new_id, trans_id, file_id)
365
unique_add(self._r_new_id, file_id, trans_id)
367
def cancel_versioning(self, trans_id):
368
"""Undo a previous versioning of a file"""
369
file_id = self._new_id[trans_id]
370
del self._new_id[trans_id]
371
del self._r_new_id[file_id]
373
def new_paths(self, filesystem_only=False):
374
"""Determine the paths of all new and changed files.
376
:param filesystem_only: if True, only calculate values for files
377
that require renames or execute bit changes.
381
stale_ids = self._needs_rename.difference(self._new_name)
382
stale_ids.difference_update(self._new_parent)
383
stale_ids.difference_update(self._new_contents)
384
stale_ids.difference_update(self._new_id)
385
needs_rename = self._needs_rename.difference(stale_ids)
386
id_sets = (needs_rename, self._new_executability)
388
id_sets = (self._new_name, self._new_parent, self._new_contents,
389
self._new_id, self._new_executability)
390
for id_set in id_sets:
391
new_ids.update(id_set)
392
return sorted(FinalPaths(self).get_paths(new_ids))
394
def _inventory_altered(self):
395
"""Determine which trans_ids need new Inventory entries.
397
An new entry is needed when anything that would be reflected by an
398
inventory entry changes, including file name, file_id, parent file_id,
399
file kind, and the execute bit.
401
Some care is taken to return entries with real changes, not cases
402
where the value is deleted and then restored to its original value,
403
but some actually unchanged values may be returned.
405
:returns: A list of (path, trans_id) for all items requiring an
406
inventory change. Ordered by path.
409
# Find entries whose file_ids are new (or changed).
410
new_file_id = set(t for t in self._new_id
411
if self._new_id[t] != self.tree_file_id(t))
412
for id_set in [self._new_name, self._new_parent, new_file_id,
413
self._new_executability]:
414
changed_ids.update(id_set)
415
# removing implies a kind change
416
changed_kind = set(self._removed_contents)
418
changed_kind.intersection_update(self._new_contents)
419
# Ignore entries that are already known to have changed.
420
changed_kind.difference_update(changed_ids)
421
# to keep only the truly changed ones
422
changed_kind = (t for t in changed_kind
423
if self.tree_kind(t) != self.final_kind(t))
424
# all kind changes will alter the inventory
425
changed_ids.update(changed_kind)
426
# To find entries with changed parent_ids, find parents which existed,
427
# but changed file_id.
428
# Now add all their children to the set.
429
for parent_trans_id in new_file_id:
430
changed_ids.update(self.iter_tree_children(parent_trans_id))
431
return sorted(FinalPaths(self).get_paths(changed_ids))
433
def final_kind(self, trans_id):
434
"""Determine the final file kind, after any changes applied.
436
:return: None if the file does not exist/has no contents. (It is
437
conceivable that a path would be created without the corresponding
438
contents insertion command)
440
if trans_id in self._new_contents:
441
return self._new_contents[trans_id]
442
elif trans_id in self._removed_contents:
445
return self.tree_kind(trans_id)
447
def tree_path(self, trans_id):
448
"""Determine the tree path associated with the trans_id."""
449
return self._tree_id_paths.get(trans_id)
451
def tree_file_id(self, trans_id):
452
"""Determine the file id associated with the trans_id in the tree"""
453
path = self.tree_path(trans_id)
456
# the file is old; the old id is still valid
457
if self._new_root == trans_id:
458
return self._tree.get_root_id()
459
return self._tree.path2id(path)
461
def final_file_id(self, trans_id):
462
"""Determine the file id after any changes are applied, or None.
464
None indicates that the file will not be versioned after changes are
468
return self._new_id[trans_id]
470
if trans_id in self._removed_id:
472
return self.tree_file_id(trans_id)
474
def inactive_file_id(self, trans_id):
475
"""Return the inactive file_id associated with a transaction id.
476
That is, the one in the tree or in non_present_ids.
477
The file_id may actually be active, too.
479
file_id = self.tree_file_id(trans_id)
480
if file_id is not None:
482
for key, value in viewitems(self._non_present_ids):
483
if value == trans_id:
486
def final_parent(self, trans_id):
487
"""Determine the parent file_id, after any changes are applied.
489
ROOT_PARENT is returned for the tree root.
492
return self._new_parent[trans_id]
494
return self.get_tree_parent(trans_id)
496
def final_name(self, trans_id):
497
"""Determine the final filename, after all changes are applied."""
499
return self._new_name[trans_id]
502
return os.path.basename(self._tree_id_paths[trans_id])
504
raise NoFinalPath(trans_id, self)
507
"""Return a map of parent: children for known parents.
509
Only new paths and parents of tree files with assigned ids are used.
512
items = list(viewitems(self._new_parent))
513
items.extend((t, self.final_parent(t))
514
for t in list(self._tree_id_paths))
515
for trans_id, parent_id in items:
516
if parent_id not in by_parent:
517
by_parent[parent_id] = set()
518
by_parent[parent_id].add(trans_id)
521
def path_changed(self, trans_id):
522
"""Return True if a trans_id's path has changed."""
523
return (trans_id in self._new_name) or (trans_id in self._new_parent)
525
def new_contents(self, trans_id):
526
return (trans_id in self._new_contents)
528
def find_conflicts(self):
529
"""Find any violations of inventory or filesystem invariants"""
530
if self._done is True:
531
raise ReusingTransform()
533
# ensure all children of all existent parents are known
534
# all children of non-existent parents are known, by definition.
535
self._add_tree_children()
536
by_parent = self.by_parent()
537
conflicts.extend(self._unversioned_parents(by_parent))
538
conflicts.extend(self._parent_loops())
539
conflicts.extend(self._duplicate_entries(by_parent))
540
conflicts.extend(self._duplicate_ids())
541
conflicts.extend(self._parent_type_conflicts(by_parent))
542
conflicts.extend(self._improper_versioning())
543
conflicts.extend(self._executability_conflicts())
544
conflicts.extend(self._overwrite_conflicts())
547
def _check_malformed(self):
548
conflicts = self.find_conflicts()
549
if len(conflicts) != 0:
550
raise MalformedTransform(conflicts=conflicts)
552
def _add_tree_children(self):
553
"""Add all the children of all active parents to the known paths.
555
Active parents are those which gain children, and those which are
556
removed. This is a necessary first step in detecting conflicts.
558
parents = list(self.by_parent())
559
parents.extend([t for t in self._removed_contents if
560
self.tree_kind(t) == 'directory'])
561
for trans_id in self._removed_id:
562
path = self.tree_path(trans_id)
564
if self._tree.stored_kind(path) == 'directory':
565
parents.append(trans_id)
566
elif self.tree_kind(trans_id) == 'directory':
567
parents.append(trans_id)
569
for parent_id in parents:
570
# ensure that all children are registered with the transaction
571
list(self.iter_tree_children(parent_id))
573
def _has_named_child(self, name, parent_id, known_children):
574
"""Does a parent already have a name child.
576
:param name: The searched for name.
578
:param parent_id: The parent for which the check is made.
580
:param known_children: The already known children. This should have
581
been recently obtained from `self.by_parent.get(parent_id)`
582
(or will be if None is passed).
584
if known_children is None:
585
known_children = self.by_parent().get(parent_id, [])
586
for child in known_children:
587
if self.final_name(child) == name:
589
parent_path = self._tree_id_paths.get(parent_id, None)
590
if parent_path is None:
591
# No parent... no children
593
child_path = joinpath(parent_path, name)
594
child_id = self._tree_path_ids.get(child_path, None)
596
# Not known by the tree transform yet, check the filesystem
597
return osutils.lexists(self._tree.abspath(child_path))
599
raise AssertionError('child_id is missing: %s, %s, %s'
600
% (name, parent_id, child_id))
602
def _available_backup_name(self, name, target_id):
603
"""Find an available backup name.
605
:param name: The basename of the file.
607
:param target_id: The directory trans_id where the backup should
610
known_children = self.by_parent().get(target_id, [])
611
return osutils.available_backup_name(
613
lambda base: self._has_named_child(
614
base, target_id, known_children))
616
def _parent_loops(self):
617
"""No entry should be its own ancestor"""
619
for trans_id in self._new_parent:
622
while parent_id != ROOT_PARENT:
625
parent_id = self.final_parent(parent_id)
628
if parent_id == trans_id:
629
conflicts.append(('parent loop', trans_id))
630
if parent_id in seen:
634
def _unversioned_parents(self, by_parent):
635
"""If parent directories are versioned, children must be versioned."""
637
for parent_id, children in viewitems(by_parent):
638
if parent_id == ROOT_PARENT:
640
if self.final_file_id(parent_id) is not None:
642
for child_id in children:
643
if self.final_file_id(child_id) is not None:
644
conflicts.append(('unversioned parent', parent_id))
648
def _improper_versioning(self):
649
"""Cannot version a file with no contents, or a bad type.
651
However, existing entries with no contents are okay.
654
for trans_id in self._new_id:
655
kind = self.final_kind(trans_id)
657
conflicts.append(('versioning no contents', trans_id))
659
if not self._tree.versionable_kind(kind):
660
conflicts.append(('versioning bad kind', trans_id, kind))
663
def _executability_conflicts(self):
664
"""Check for bad executability changes.
666
Only versioned files may have their executability set, because
667
1. only versioned entries can have executability under windows
668
2. only files can be executable. (The execute bit on a directory
669
does not indicate searchability)
672
for trans_id in self._new_executability:
673
if self.final_file_id(trans_id) is None:
674
conflicts.append(('unversioned executability', trans_id))
676
if self.final_kind(trans_id) != "file":
677
conflicts.append(('non-file executability', trans_id))
680
def _overwrite_conflicts(self):
681
"""Check for overwrites (not permitted on Win32)"""
683
for trans_id in self._new_contents:
684
if self.tree_kind(trans_id) is None:
686
if trans_id not in self._removed_contents:
687
conflicts.append(('overwrite', trans_id,
688
self.final_name(trans_id)))
691
def _duplicate_entries(self, by_parent):
692
"""No directory may have two entries with the same name."""
694
if (self._new_name, self._new_parent) == ({}, {}):
696
for children in viewvalues(by_parent):
698
for child_tid in children:
699
name = self.final_name(child_tid)
701
# Keep children only if they still exist in the end
702
if not self._case_sensitive_target:
704
name_ids.append((name, child_tid))
708
for name, trans_id in name_ids:
709
kind = self.final_kind(trans_id)
710
file_id = self.final_file_id(trans_id)
711
if kind is None and file_id is None:
713
if name == last_name:
714
conflicts.append(('duplicate', last_trans_id, trans_id,
717
last_trans_id = trans_id
720
def _duplicate_ids(self):
721
"""Each inventory id may only be used once"""
724
all_ids = self._tree.all_file_ids()
725
except errors.UnsupportedOperation:
726
# it's okay for non-file-id trees to raise UnsupportedOperation.
728
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
730
active_tree_ids = all_ids.difference(removed_tree_ids)
731
for trans_id, file_id in viewitems(self._new_id):
732
if file_id in active_tree_ids:
733
path = self._tree.id2path(file_id)
734
old_trans_id = self.trans_id_tree_path(path)
735
conflicts.append(('duplicate id', old_trans_id, trans_id))
738
def _parent_type_conflicts(self, by_parent):
739
"""Children must have a directory parent"""
741
for parent_id, children in viewitems(by_parent):
742
if parent_id == ROOT_PARENT:
745
for child_id in children:
746
if self.final_kind(child_id) is not None:
751
# There is at least a child, so we need an existing directory to
753
kind = self.final_kind(parent_id)
755
# The directory will be deleted
756
conflicts.append(('missing parent', parent_id))
757
elif kind != "directory":
758
# Meh, we need a *directory* to put something in it
759
conflicts.append(('non-directory parent', parent_id))
762
def _set_executability(self, path, trans_id):
763
"""Set the executability of versioned files """
764
if self._tree._supports_executable():
765
new_executability = self._new_executability[trans_id]
766
abspath = self._tree.abspath(path)
767
current_mode = os.stat(abspath).st_mode
768
if new_executability:
771
to_mode = current_mode | (0o100 & ~umask)
772
# Enable x-bit for others only if they can read it.
773
if current_mode & 0o004:
774
to_mode |= 0o001 & ~umask
775
if current_mode & 0o040:
776
to_mode |= 0o010 & ~umask
778
to_mode = current_mode & ~0o111
779
osutils.chmod_if_possible(abspath, to_mode)
781
def _new_entry(self, name, parent_id, file_id):
782
"""Helper function to create a new filesystem entry."""
783
trans_id = self.create_path(name, parent_id)
784
if file_id is not None:
785
self.version_file(file_id, trans_id)
788
def new_file(self, name, parent_id, contents, file_id=None,
789
executable=None, sha1=None):
790
"""Convenience method to create files.
792
name is the name of the file to create.
793
parent_id is the transaction id of the parent directory of the file.
794
contents is an iterator of bytestrings, which will be used to produce
796
:param file_id: The inventory ID of the file, if it is to be versioned.
797
:param executable: Only valid when a file_id has been supplied.
799
trans_id = self._new_entry(name, parent_id, file_id)
800
# TODO: rather than scheduling a set_executable call,
801
# have create_file create the file with the right mode.
802
self.create_file(contents, trans_id, sha1=sha1)
803
if executable is not None:
804
self.set_executability(executable, trans_id)
807
def new_directory(self, name, parent_id, file_id=None):
808
"""Convenience method to create directories.
810
name is the name of the directory to create.
811
parent_id is the transaction id of the parent directory of the
813
file_id is the inventory ID of the directory, if it is to be versioned.
815
trans_id = self._new_entry(name, parent_id, file_id)
816
self.create_directory(trans_id)
819
def new_symlink(self, name, parent_id, target, file_id=None):
820
"""Convenience method to create symbolic link.
822
name is the name of the symlink to create.
823
parent_id is the transaction id of the parent directory of the symlink.
824
target is a bytestring of the target of the symlink.
825
file_id is the inventory ID of the file, if it is to be versioned.
827
trans_id = self._new_entry(name, parent_id, file_id)
828
self.create_symlink(target, trans_id)
831
def new_orphan(self, trans_id, parent_id):
832
"""Schedule an item to be orphaned.
834
When a directory is about to be removed, its children, if they are not
835
versioned are moved out of the way: they don't have a parent anymore.
837
:param trans_id: The trans_id of the existing item.
838
:param parent_id: The parent trans_id of the item.
840
raise NotImplementedError(self.new_orphan)
842
def _get_potential_orphans(self, dir_id):
843
"""Find the potential orphans in a directory.
845
A directory can't be safely deleted if there are versioned files in it.
846
If all the contained files are unversioned then they can be orphaned.
848
The 'None' return value means that the directory contains at least one
849
versioned file and should not be deleted.
851
:param dir_id: The directory trans id.
853
:return: A list of the orphan trans ids or None if at least one
854
versioned file is present.
857
# Find the potential orphans, stop if one item should be kept
858
for child_tid in self.by_parent()[dir_id]:
859
if child_tid in self._removed_contents:
860
# The child is removed as part of the transform. Since it was
861
# versioned before, it's not an orphan
863
elif self.final_file_id(child_tid) is None:
864
# The child is not versioned
865
orphans.append(child_tid)
867
# We have a versioned file here, searching for orphans is
873
def _affected_ids(self):
874
"""Return the set of transform ids affected by the transform"""
875
trans_ids = set(self._removed_id)
876
trans_ids.update(self._new_id)
877
trans_ids.update(self._removed_contents)
878
trans_ids.update(self._new_contents)
879
trans_ids.update(self._new_executability)
880
trans_ids.update(self._new_name)
881
trans_ids.update(self._new_parent)
884
def _get_file_id_maps(self):
885
"""Return mapping of file_ids to trans_ids in the to and from states"""
886
trans_ids = self._affected_ids()
889
# Build up two dicts: trans_ids associated with file ids in the
890
# FROM state, vs the TO state.
891
for trans_id in trans_ids:
892
from_file_id = self.tree_file_id(trans_id)
893
if from_file_id is not None:
894
from_trans_ids[from_file_id] = trans_id
895
to_file_id = self.final_file_id(trans_id)
896
if to_file_id is not None:
897
to_trans_ids[to_file_id] = trans_id
898
return from_trans_ids, to_trans_ids
900
def _from_file_data(self, from_trans_id, from_versioned, from_path):
901
"""Get data about a file in the from (tree) state
903
Return a (name, parent, kind, executable) tuple
905
from_path = self._tree_id_paths.get(from_trans_id)
907
# get data from working tree if versioned
908
from_entry = next(self._tree.iter_entries_by_dir(
909
specific_files=[from_path]))[1]
910
from_name = from_entry.name
911
from_parent = from_entry.parent_id
914
if from_path is None:
915
# File does not exist in FROM state
919
# File exists, but is not versioned. Have to use path-
921
from_name = os.path.basename(from_path)
922
tree_parent = self.get_tree_parent(from_trans_id)
923
from_parent = self.tree_file_id(tree_parent)
924
if from_path is not None:
925
from_kind, from_executable, from_stats = \
926
self._tree._comparison_data(from_entry, from_path)
929
from_executable = False
930
return from_name, from_parent, from_kind, from_executable
932
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
933
"""Get data about a file in the to (target) state
935
Return a (name, parent, kind, executable) tuple
937
to_name = self.final_name(to_trans_id)
938
to_kind = self.final_kind(to_trans_id)
939
to_parent = self.final_file_id(self.final_parent(to_trans_id))
940
if to_trans_id in self._new_executability:
941
to_executable = self._new_executability[to_trans_id]
942
elif to_trans_id == from_trans_id:
943
to_executable = from_executable
945
to_executable = False
946
return to_name, to_parent, to_kind, to_executable
948
def iter_changes(self):
949
"""Produce output in the same format as Tree.iter_changes.
951
Will produce nonsensical results if invoked while inventory/filesystem
952
conflicts (as reported by TreeTransform.find_conflicts()) are present.
954
This reads the Transform, but only reproduces changes involving a
955
file_id. Files that are not versioned in either of the FROM or TO
956
states are not reflected.
958
final_paths = FinalPaths(self)
959
from_trans_ids, to_trans_ids = self._get_file_id_maps()
961
# Now iterate through all active file_ids
962
for file_id in set(from_trans_ids).union(to_trans_ids):
964
from_trans_id = from_trans_ids.get(file_id)
965
# find file ids, and determine versioning state
966
if from_trans_id is None:
967
from_versioned = False
968
from_trans_id = to_trans_ids[file_id]
970
from_versioned = True
971
to_trans_id = to_trans_ids.get(file_id)
972
if to_trans_id is None:
974
to_trans_id = from_trans_id
978
if not from_versioned:
981
from_path = self._tree_id_paths.get(from_trans_id)
985
to_path = final_paths.get_path(to_trans_id)
987
from_name, from_parent, from_kind, from_executable = \
988
self._from_file_data(from_trans_id, from_versioned, from_path)
990
to_name, to_parent, to_kind, to_executable = \
991
self._to_file_data(to_trans_id, from_trans_id, from_executable)
993
if from_kind != to_kind:
995
elif to_kind in ('file', 'symlink') and (
996
to_trans_id != from_trans_id
997
or to_trans_id in self._new_contents):
999
if (not modified and from_versioned == to_versioned
1000
and from_parent == to_parent and from_name == to_name
1001
and from_executable == to_executable):
1003
results.append((file_id, (from_path, to_path), modified,
1004
(from_versioned, to_versioned),
1005
(from_parent, to_parent),
1006
(from_name, to_name),
1007
(from_kind, to_kind),
1008
(from_executable, to_executable)))
1012
return (paths[0] or '', paths[1] or '')
1013
return iter(sorted(results, key=path_key))
1015
def get_preview_tree(self):
1016
"""Return a tree representing the result of the transform.
1018
The tree is a snapshot, and altering the TreeTransform will invalidate
1021
return _PreviewTree(self)
1023
def commit(self, branch, message, merge_parents=None, strict=False,
1024
timestamp=None, timezone=None, committer=None, authors=None,
1025
revprops=None, revision_id=None):
1026
"""Commit the result of this TreeTransform to a branch.
1028
:param branch: The branch to commit to.
1029
:param message: The message to attach to the commit.
1030
:param merge_parents: Additional parent revision-ids specified by
1032
:param strict: If True, abort the commit if there are unversioned
1034
:param timestamp: if not None, seconds-since-epoch for the time and
1035
date. (May be a float.)
1036
:param timezone: Optional timezone for timestamp, as an offset in
1038
:param committer: Optional committer in email-id format.
1039
(e.g. "J Random Hacker <jrandom@example.com>")
1040
:param authors: Optional list of authors in email-id format.
1041
:param revprops: Optional dictionary of revision properties.
1042
:param revision_id: Optional revision id. (Specifying a revision-id
1043
may reduce performance for some non-native formats.)
1044
:return: The revision_id of the revision committed.
1046
self._check_malformed()
1048
unversioned = set(self._new_contents).difference(set(self._new_id))
1049
for trans_id in unversioned:
1050
if self.final_file_id(trans_id) is None:
1051
raise errors.StrictCommitFailed()
1053
revno, last_rev_id = branch.last_revision_info()
1054
if last_rev_id == _mod_revision.NULL_REVISION:
1055
if merge_parents is not None:
1056
raise ValueError('Cannot supply merge parents for first'
1060
parent_ids = [last_rev_id]
1061
if merge_parents is not None:
1062
parent_ids.extend(merge_parents)
1063
if self._tree.get_revision_id() != last_rev_id:
1064
raise ValueError('TreeTransform not based on branch basis: %s' %
1065
self._tree.get_revision_id().decode('utf-8'))
1066
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1067
builder = branch.get_commit_builder(parent_ids,
1068
timestamp=timestamp,
1070
committer=committer,
1072
revision_id=revision_id)
1073
preview = self.get_preview_tree()
1074
list(builder.record_iter_changes(preview, last_rev_id,
1075
self.iter_changes()))
1076
builder.finish_inventory()
1077
revision_id = builder.commit(message)
1078
branch.set_last_revision_info(revno + 1, revision_id)
1081
def _text_parent(self, trans_id):
1082
path = self.tree_path(trans_id)
1084
if path is None or self._tree.kind(path) != 'file':
1086
except errors.NoSuchFile:
1090
def _get_parents_texts(self, trans_id):
1091
"""Get texts for compression parents of this file."""
1092
path = self._text_parent(trans_id)
1095
return (self._tree.get_file_text(path),)
1097
def _get_parents_lines(self, trans_id):
1098
"""Get lines for compression parents of this file."""
1099
path = self._text_parent(trans_id)
1102
return (self._tree.get_file_lines(path),)
1104
def serialize(self, serializer):
1105
"""Serialize this TreeTransform.
1107
:param serializer: A Serialiser like pack.ContainerSerializer.
1109
new_name = {k.encode('utf-8'): v.encode('utf-8')
1110
for k, v in viewitems(self._new_name)}
1111
new_parent = {k.encode('utf-8'): v.encode('utf-8')
1112
for k, v in viewitems(self._new_parent)}
1113
new_id = {k.encode('utf-8'): v
1114
for k, v in viewitems(self._new_id)}
1115
new_executability = {k.encode('utf-8'): int(v)
1116
for k, v in viewitems(self._new_executability)}
1117
tree_path_ids = {k.encode('utf-8'): v.encode('utf-8')
1118
for k, v in viewitems(self._tree_path_ids)}
1119
non_present_ids = {k: v.encode('utf-8')
1120
for k, v in viewitems(self._non_present_ids)}
1121
removed_contents = [trans_id.encode('utf-8')
1122
for trans_id in self._removed_contents]
1123
removed_id = [trans_id.encode('utf-8')
1124
for trans_id in self._removed_id]
1126
b'_id_number': self._id_number,
1127
b'_new_name': new_name,
1128
b'_new_parent': new_parent,
1129
b'_new_executability': new_executability,
1131
b'_tree_path_ids': tree_path_ids,
1132
b'_removed_id': removed_id,
1133
b'_removed_contents': removed_contents,
1134
b'_non_present_ids': non_present_ids,
1136
yield serializer.bytes_record(bencode.bencode(attribs),
1138
for trans_id, kind in sorted(viewitems(self._new_contents)):
1140
with open(self._limbo_name(trans_id), 'rb') as cur_file:
1141
lines = cur_file.readlines()
1142
parents = self._get_parents_lines(trans_id)
1143
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1144
content = b''.join(mpdiff.to_patch())
1145
if kind == 'directory':
1147
if kind == 'symlink':
1148
content = self._read_symlink_target(trans_id)
1149
if not isinstance(content, bytes):
1150
content = content.encode('utf-8')
1151
yield serializer.bytes_record(
1152
content, ((trans_id.encode('utf-8'), kind.encode('ascii')),))
1154
def deserialize(self, records):
1155
"""Deserialize a stored TreeTransform.
1157
:param records: An iterable of (names, content) tuples, as per
1158
pack.ContainerPushParser.
1160
names, content = next(records)
1161
attribs = bencode.bdecode(content)
1162
self._id_number = attribs[b'_id_number']
1163
self._new_name = {k.decode('utf-8'): v.decode('utf-8')
1164
for k, v in viewitems(attribs[b'_new_name'])}
1165
self._new_parent = {k.decode('utf-8'): v.decode('utf-8')
1166
for k, v in viewitems(attribs[b'_new_parent'])}
1167
self._new_executability = {
1168
k.decode('utf-8'): bool(v)
1169
for k, v in viewitems(attribs[b'_new_executability'])}
1170
self._new_id = {k.decode('utf-8'): v
1171
for k, v in viewitems(attribs[b'_new_id'])}
1172
self._r_new_id = {v: k for k, v in viewitems(self._new_id)}
1173
self._tree_path_ids = {}
1174
self._tree_id_paths = {}
1175
for bytepath, trans_id in viewitems(attribs[b'_tree_path_ids']):
1176
path = bytepath.decode('utf-8')
1177
trans_id = trans_id.decode('utf-8')
1178
self._tree_path_ids[path] = trans_id
1179
self._tree_id_paths[trans_id] = path
1180
self._removed_id = {trans_id.decode('utf-8')
1181
for trans_id in attribs[b'_removed_id']}
1182
self._removed_contents = set(
1183
trans_id.decode('utf-8')
1184
for trans_id in attribs[b'_removed_contents'])
1185
self._non_present_ids = {
1186
k: v.decode('utf-8')
1187
for k, v in viewitems(attribs[b'_non_present_ids'])}
1188
for ((trans_id, kind),), content in records:
1189
trans_id = trans_id.decode('utf-8')
1190
kind = kind.decode('ascii')
1192
mpdiff = multiparent.MultiParent.from_patch(content)
1193
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1194
self.create_file(lines, trans_id)
1195
if kind == 'directory':
1196
self.create_directory(trans_id)
1197
if kind == 'symlink':
1198
self.create_symlink(content.decode('utf-8'), trans_id)
1201
class DiskTreeTransform(TreeTransformBase):
1202
"""Tree transform storing its contents on disk."""
1204
def __init__(self, tree, limbodir, pb=None,
1205
case_sensitive=True):
1207
:param tree: The tree that will be transformed, but not necessarily
1209
:param limbodir: A directory where new files can be stored until
1210
they are installed in their proper places
1212
:param case_sensitive: If True, the target of the transform is
1213
case sensitive, not just case preserving.
1215
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1216
self._limbodir = limbodir
1217
self._deletiondir = None
1218
# A mapping of transform ids to their limbo filename
1219
self._limbo_files = {}
1220
self._possibly_stale_limbo_files = set()
1221
# A mapping of transform ids to a set of the transform ids of children
1222
# that their limbo directory has
1223
self._limbo_children = {}
1224
# Map transform ids to maps of child filename to child transform id
1225
self._limbo_children_names = {}
1226
# List of transform ids that need to be renamed from limbo into place
1227
self._needs_rename = set()
1228
self._creation_mtime = None
1231
"""Release the working tree lock, if held, clean up limbo dir.
1233
This is required if apply has not been invoked, but can be invoked
1236
if self._tree is None:
1239
limbo_paths = list(viewvalues(self._limbo_files))
1240
limbo_paths.extend(self._possibly_stale_limbo_files)
1241
limbo_paths.sort(reverse=True)
1242
for path in limbo_paths:
1245
except OSError as e:
1246
if e.errno != errno.ENOENT:
1248
# XXX: warn? perhaps we just got interrupted at an
1249
# inconvenient moment, but perhaps files are disappearing
1252
delete_any(self._limbodir)
1254
# We don't especially care *why* the dir is immortal.
1255
raise ImmortalLimbo(self._limbodir)
1257
if self._deletiondir is not None:
1258
delete_any(self._deletiondir)
1260
raise errors.ImmortalPendingDeletion(self._deletiondir)
1262
TreeTransformBase.finalize(self)
1264
def _limbo_supports_executable(self):
1265
"""Check if the limbo path supports the executable bit."""
1266
# FIXME: Check actual file system capabilities of limbodir
1267
return osutils.supports_executable()
1269
def _limbo_name(self, trans_id):
1270
"""Generate the limbo name of a file"""
1271
limbo_name = self._limbo_files.get(trans_id)
1272
if limbo_name is None:
1273
limbo_name = self._generate_limbo_path(trans_id)
1274
self._limbo_files[trans_id] = limbo_name
1277
def _generate_limbo_path(self, trans_id):
1278
"""Generate a limbo path using the trans_id as the relative path.
1280
This is suitable as a fallback, and when the transform should not be
1281
sensitive to the path encoding of the limbo directory.
1283
self._needs_rename.add(trans_id)
1284
return pathjoin(self._limbodir, trans_id)
1286
def adjust_path(self, name, parent, trans_id):
1287
previous_parent = self._new_parent.get(trans_id)
1288
previous_name = self._new_name.get(trans_id)
1289
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1290
if (trans_id in self._limbo_files
1291
and trans_id not in self._needs_rename):
1292
self._rename_in_limbo([trans_id])
1293
if previous_parent != parent:
1294
self._limbo_children[previous_parent].remove(trans_id)
1295
if previous_parent != parent or previous_name != name:
1296
del self._limbo_children_names[previous_parent][previous_name]
1298
def _rename_in_limbo(self, trans_ids):
1299
"""Fix limbo names so that the right final path is produced.
1301
This means we outsmarted ourselves-- we tried to avoid renaming
1302
these files later by creating them with their final names in their
1303
final parents. But now the previous name or parent is no longer
1304
suitable, so we have to rename them.
1306
Even for trans_ids that have no new contents, we must remove their
1307
entries from _limbo_files, because they are now stale.
1309
for trans_id in trans_ids:
1310
old_path = self._limbo_files[trans_id]
1311
self._possibly_stale_limbo_files.add(old_path)
1312
del self._limbo_files[trans_id]
1313
if trans_id not in self._new_contents:
1315
new_path = self._limbo_name(trans_id)
1316
os.rename(old_path, new_path)
1317
self._possibly_stale_limbo_files.remove(old_path)
1318
for descendant in self._limbo_descendants(trans_id):
1319
desc_path = self._limbo_files[descendant]
1320
desc_path = new_path + desc_path[len(old_path):]
1321
self._limbo_files[descendant] = desc_path
1323
def _limbo_descendants(self, trans_id):
1324
"""Return the set of trans_ids whose limbo paths descend from this."""
1325
descendants = set(self._limbo_children.get(trans_id, []))
1326
for descendant in list(descendants):
1327
descendants.update(self._limbo_descendants(descendant))
1330
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1331
"""Schedule creation of a new file.
1335
:param contents: an iterator of strings, all of which will be written
1336
to the target destination.
1337
:param trans_id: TreeTransform handle
1338
:param mode_id: If not None, force the mode of the target file to match
1339
the mode of the object referenced by mode_id.
1340
Otherwise, we will try to preserve mode bits of an existing file.
1341
:param sha1: If the sha1 of this content is already known, pass it in.
1342
We can use it to prevent future sha1 computations.
1344
name = self._limbo_name(trans_id)
1345
with open(name, 'wb') as f:
1346
unique_add(self._new_contents, trans_id, 'file')
1347
f.writelines(contents)
1348
self._set_mtime(name)
1349
self._set_mode(trans_id, mode_id, S_ISREG)
1350
# It is unfortunate we have to use lstat instead of fstat, but we just
1351
# used utime and chmod on the file, so we need the accurate final
1353
if sha1 is not None:
1354
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1356
def _read_symlink_target(self, trans_id):
1357
return os.readlink(self._limbo_name(trans_id))
1359
def _set_mtime(self, path):
1360
"""All files that are created get the same mtime.
1362
This time is set by the first object to be created.
1364
if self._creation_mtime is None:
1365
self._creation_mtime = time.time()
1366
os.utime(path, (self._creation_mtime, self._creation_mtime))
1368
def create_hardlink(self, path, trans_id):
1369
"""Schedule creation of a hard link"""
1370
name = self._limbo_name(trans_id)
1373
except OSError as e:
1374
if e.errno != errno.EPERM:
1376
raise errors.HardLinkNotSupported(path)
1378
unique_add(self._new_contents, trans_id, 'file')
1379
except BaseException:
1380
# Clean up the file, it never got registered so
1381
# TreeTransform.finalize() won't clean it up.
1385
def create_directory(self, trans_id):
1386
"""Schedule creation of a new directory.
1388
See also new_directory.
1390
os.mkdir(self._limbo_name(trans_id))
1391
unique_add(self._new_contents, trans_id, 'directory')
1393
def create_symlink(self, target, trans_id):
1394
"""Schedule creation of a new symbolic link.
1396
target is a bytestring.
1397
See also new_symlink.
1400
os.symlink(target, self._limbo_name(trans_id))
1401
unique_add(self._new_contents, trans_id, 'symlink')
1404
path = FinalPaths(self).get_path(trans_id)
1407
raise UnableCreateSymlink(path=path)
1409
def cancel_creation(self, trans_id):
1410
"""Cancel the creation of new file contents."""
1411
del self._new_contents[trans_id]
1412
if trans_id in self._observed_sha1s:
1413
del self._observed_sha1s[trans_id]
1414
children = self._limbo_children.get(trans_id)
1415
# if this is a limbo directory with children, move them before removing
1417
if children is not None:
1418
self._rename_in_limbo(children)
1419
del self._limbo_children[trans_id]
1420
del self._limbo_children_names[trans_id]
1421
delete_any(self._limbo_name(trans_id))
1423
def new_orphan(self, trans_id, parent_id):
1424
conf = self._tree.get_config_stack()
1425
handle_orphan = conf.get('transform.orphan_policy')
1426
handle_orphan(self, trans_id, parent_id)
1429
class OrphaningError(errors.BzrError):
1431
# Only bugs could lead to such exception being seen by the user
1432
internal_error = True
1433
_fmt = "Error while orphaning %s in %s directory"
1435
def __init__(self, orphan, parent):
1436
errors.BzrError.__init__(self)
1437
self.orphan = orphan
1438
self.parent = parent
1441
class OrphaningForbidden(OrphaningError):
1443
_fmt = "Policy: %s doesn't allow creating orphans."
1445
def __init__(self, policy):
1446
errors.BzrError.__init__(self)
1447
self.policy = policy
1450
def move_orphan(tt, orphan_id, parent_id):
1451
"""See TreeTransformBase.new_orphan.
1453
This creates a new orphan in the `brz-orphans` dir at the root of the
1456
:param tt: The TreeTransform orphaning `trans_id`.
1458
:param orphan_id: The trans id that should be orphaned.
1460
:param parent_id: The orphan parent trans id.
1462
# Add the orphan dir if it doesn't exist
1463
orphan_dir_basename = 'brz-orphans'
1464
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1465
if tt.final_kind(od_id) is None:
1466
tt.create_directory(od_id)
1467
parent_path = tt._tree_id_paths[parent_id]
1468
# Find a name that doesn't exist yet in the orphan dir
1469
actual_name = tt.final_name(orphan_id)
1470
new_name = tt._available_backup_name(actual_name, od_id)
1471
tt.adjust_path(new_name, od_id, orphan_id)
1472
trace.warning('%s has been orphaned in %s'
1473
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1476
def refuse_orphan(tt, orphan_id, parent_id):
1477
"""See TreeTransformBase.new_orphan.
1479
This refuses to create orphan, letting the caller handle the conflict.
1481
raise OrphaningForbidden('never')
1484
orphaning_registry = registry.Registry()
1485
orphaning_registry.register(
1486
u'conflict', refuse_orphan,
1487
'Leave orphans in place and create a conflict on the directory.')
1488
orphaning_registry.register(
1489
u'move', move_orphan,
1490
'Move orphans into the brz-orphans directory.')
1491
orphaning_registry._set_default_key(u'conflict')
1494
opt_transform_orphan = _mod_config.RegistryOption(
1495
'transform.orphan_policy', orphaning_registry,
1496
help='Policy for orphaned files during transform operations.',
1500
class TreeTransform(DiskTreeTransform):
1501
"""Represent a tree transformation.
1503
This object is designed to support incremental generation of the transform,
1506
However, it gives optimum performance when parent directories are created
1507
before their contents. The transform is then able to put child files
1508
directly in their parent directory, avoiding later renames.
1510
It is easy to produce malformed transforms, but they are generally
1511
harmless. Attempting to apply a malformed transform will cause an
1512
exception to be raised before any modifications are made to the tree.
1514
Many kinds of malformed transforms can be corrected with the
1515
resolve_conflicts function. The remaining ones indicate programming error,
1516
such as trying to create a file with no path.
1518
Two sets of file creation methods are supplied. Convenience methods are:
1523
These are composed of the low-level methods:
1525
* create_file or create_directory or create_symlink
1529
Transform/Transaction ids
1530
-------------------------
1531
trans_ids are temporary ids assigned to all files involved in a transform.
1532
It's possible, even common, that not all files in the Tree have trans_ids.
1534
trans_ids are used because filenames and file_ids are not good enough
1535
identifiers; filenames change, and not all files have file_ids. File-ids
1536
are also associated with trans-ids, so that moving a file moves its
1539
trans_ids are only valid for the TreeTransform that generated them.
1543
Limbo is a temporary directory use to hold new versions of files.
1544
Files are added to limbo by create_file, create_directory, create_symlink,
1545
and their convenience variants (new_*). Files may be removed from limbo
1546
using cancel_creation. Files are renamed from limbo into their final
1547
location as part of TreeTransform.apply
1549
Limbo must be cleaned up, by either calling TreeTransform.apply or
1550
calling TreeTransform.finalize.
1552
Files are placed into limbo inside their parent directories, where
1553
possible. This reduces subsequent renames, and makes operations involving
1554
lots of files faster. This optimization is only possible if the parent
1555
directory is created *before* creating any of its children, so avoid
1556
creating children before parents, where possible.
1560
This temporary directory is used by _FileMover for storing files that are
1561
about to be deleted. In case of rollback, the files will be restored.
1562
FileMover does not delete files until it is sure that a rollback will not
1566
def __init__(self, tree, pb=None):
1567
"""Note: a tree_write lock is taken on the tree.
1569
Use TreeTransform.finalize() to release the lock (can be omitted if
1570
TreeTransform.apply() called).
1572
tree.lock_tree_write()
1574
limbodir = urlutils.local_path_from_url(
1575
tree._transport.abspath('limbo'))
1576
osutils.ensure_empty_directory_exists(
1578
errors.ExistingLimbo)
1579
deletiondir = urlutils.local_path_from_url(
1580
tree._transport.abspath('pending-deletion'))
1581
osutils.ensure_empty_directory_exists(
1583
errors.ExistingPendingDeletion)
1584
except BaseException:
1588
# Cache of realpath results, to speed up canonical_path
1589
self._realpaths = {}
1590
# Cache of relpath results, to speed up canonical_path
1592
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1593
tree.case_sensitive)
1594
self._deletiondir = deletiondir
1596
def canonical_path(self, path):
1597
"""Get the canonical tree-relative path"""
1598
# don't follow final symlinks
1599
abs = self._tree.abspath(path)
1600
if abs in self._relpaths:
1601
return self._relpaths[abs]
1602
dirname, basename = os.path.split(abs)
1603
if dirname not in self._realpaths:
1604
self._realpaths[dirname] = os.path.realpath(dirname)
1605
dirname = self._realpaths[dirname]
1606
abs = pathjoin(dirname, basename)
1607
if dirname in self._relpaths:
1608
relpath = pathjoin(self._relpaths[dirname], basename)
1609
relpath = relpath.rstrip('/\\')
1611
relpath = self._tree.relpath(abs)
1612
self._relpaths[abs] = relpath
1615
def tree_kind(self, trans_id):
1616
"""Determine the file kind in the working tree.
1618
:returns: The file kind or None if the file does not exist
1620
path = self._tree_id_paths.get(trans_id)
1624
return file_kind(self._tree.abspath(path))
1625
except errors.NoSuchFile:
1628
def _set_mode(self, trans_id, mode_id, typefunc):
1629
"""Set the mode of new file contents.
1630
The mode_id is the existing file to get the mode from (often the same
1631
as trans_id). The operation is only performed if there's a mode match
1632
according to typefunc.
1637
old_path = self._tree_id_paths[mode_id]
1641
mode = os.stat(self._tree.abspath(old_path)).st_mode
1642
except OSError as e:
1643
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1644
# Either old_path doesn't exist, or the parent of the
1645
# target is not a directory (but will be one eventually)
1646
# Either way, we know it doesn't exist *right now*
1647
# See also bug #248448
1652
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1654
def iter_tree_children(self, parent_id):
1655
"""Iterate through the entry's tree children, if any"""
1657
path = self._tree_id_paths[parent_id]
1661
children = os.listdir(self._tree.abspath(path))
1662
except OSError as e:
1663
if not (osutils._is_error_enotdir(e) or
1664
e.errno in (errno.ENOENT, errno.ESRCH)):
1668
for child in children:
1669
childpath = joinpath(path, child)
1670
if self._tree.is_control_filename(childpath):
1672
yield self.trans_id_tree_path(childpath)
1674
def _generate_limbo_path(self, trans_id):
1675
"""Generate a limbo path using the final path if possible.
1677
This optimizes the performance of applying the tree transform by
1678
avoiding renames. These renames can be avoided only when the parent
1679
directory is already scheduled for creation.
1681
If the final path cannot be used, falls back to using the trans_id as
1684
parent = self._new_parent.get(trans_id)
1685
# if the parent directory is already in limbo (e.g. when building a
1686
# tree), choose a limbo name inside the parent, to reduce further
1688
use_direct_path = False
1689
if self._new_contents.get(parent) == 'directory':
1690
filename = self._new_name.get(trans_id)
1691
if filename is not None:
1692
if parent not in self._limbo_children:
1693
self._limbo_children[parent] = set()
1694
self._limbo_children_names[parent] = {}
1695
use_direct_path = True
1696
# the direct path can only be used if no other file has
1697
# already taken this pathname, i.e. if the name is unused, or
1698
# if it is already associated with this trans_id.
1699
elif self._case_sensitive_target:
1700
if (self._limbo_children_names[parent].get(filename)
1701
in (trans_id, None)):
1702
use_direct_path = True
1704
for l_filename, l_trans_id in viewitems(
1705
self._limbo_children_names[parent]):
1706
if l_trans_id == trans_id:
1708
if l_filename.lower() == filename.lower():
1711
use_direct_path = True
1713
if not use_direct_path:
1714
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1716
limbo_name = pathjoin(self._limbo_files[parent], filename)
1717
self._limbo_children[parent].add(trans_id)
1718
self._limbo_children_names[parent][filename] = trans_id
1721
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1722
"""Apply all changes to the inventory and filesystem.
1724
If filesystem or inventory conflicts are present, MalformedTransform
1727
If apply succeeds, finalize is not necessary.
1729
:param no_conflicts: if True, the caller guarantees there are no
1730
conflicts, so no check is made.
1731
:param precomputed_delta: An inventory delta to use instead of
1733
:param _mover: Supply an alternate FileMover, for testing
1735
for hook in MutableTree.hooks['pre_transform']:
1736
hook(self._tree, self)
1737
if not no_conflicts:
1738
self._check_malformed()
1739
with ui.ui_factory.nested_progress_bar() as child_pb:
1740
if precomputed_delta is None:
1741
child_pb.update(gettext('Apply phase'), 0, 2)
1742
inventory_delta = self._generate_inventory_delta()
1745
inventory_delta = precomputed_delta
1748
mover = _FileMover()
1752
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1753
self._apply_removals(mover)
1754
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1755
modified_paths = self._apply_insertions(mover)
1756
except BaseException:
1760
mover.apply_deletions()
1761
if self.final_file_id(self.root) is None:
1762
inventory_delta = [e for e in inventory_delta if e[0] != '']
1763
self._tree.apply_inventory_delta(inventory_delta)
1764
self._apply_observed_sha1s()
1767
return _TransformResults(modified_paths, self.rename_count)
1769
def _generate_inventory_delta(self):
1770
"""Generate an inventory delta for the current transform."""
1771
inventory_delta = []
1772
new_paths = self._inventory_altered()
1773
total_entries = len(new_paths) + len(self._removed_id)
1774
with ui.ui_factory.nested_progress_bar() as child_pb:
1775
for num, trans_id in enumerate(self._removed_id):
1777
child_pb.update(gettext('removing file'),
1779
if trans_id == self._new_root:
1780
file_id = self._tree.get_root_id()
1782
file_id = self.tree_file_id(trans_id)
1783
# File-id isn't really being deleted, just moved
1784
if file_id in self._r_new_id:
1786
path = self._tree_id_paths[trans_id]
1787
inventory_delta.append((path, None, file_id, None))
1788
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1790
for num, (path, trans_id) in enumerate(new_paths):
1792
child_pb.update(gettext('adding file'),
1793
num + len(self._removed_id), total_entries)
1794
file_id = new_path_file_ids[trans_id]
1797
kind = self.final_kind(trans_id)
1799
kind = self._tree.stored_kind(
1800
self._tree.id2path(file_id), file_id)
1801
parent_trans_id = self.final_parent(trans_id)
1802
parent_file_id = new_path_file_ids.get(parent_trans_id)
1803
if parent_file_id is None:
1804
parent_file_id = self.final_file_id(parent_trans_id)
1805
if trans_id in self._new_reference_revision:
1806
new_entry = inventory.TreeReference(
1808
self._new_name[trans_id],
1809
self.final_file_id(self._new_parent[trans_id]),
1810
None, self._new_reference_revision[trans_id])
1812
new_entry = inventory.make_entry(kind,
1813
self.final_name(trans_id),
1814
parent_file_id, file_id)
1816
old_path = self._tree.id2path(new_entry.file_id)
1817
except errors.NoSuchId:
1819
new_executability = self._new_executability.get(trans_id)
1820
if new_executability is not None:
1821
new_entry.executable = new_executability
1822
inventory_delta.append(
1823
(old_path, path, new_entry.file_id, new_entry))
1824
return inventory_delta
1826
def _apply_removals(self, mover):
1827
"""Perform tree operations that remove directory/inventory names.
1829
That is, delete files that are to be deleted, and put any files that
1830
need renaming into limbo. This must be done in strict child-to-parent
1833
If inventory_delta is None, no inventory delta generation is performed.
1835
tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
1836
with ui.ui_factory.nested_progress_bar() as child_pb:
1837
for num, (path, trans_id) in enumerate(tree_paths):
1838
# do not attempt to move root into a subdirectory of itself.
1841
child_pb.update(gettext('removing file'), num, len(tree_paths))
1842
full_path = self._tree.abspath(path)
1843
if trans_id in self._removed_contents:
1844
delete_path = os.path.join(self._deletiondir, trans_id)
1845
mover.pre_delete(full_path, delete_path)
1846
elif (trans_id in self._new_name or
1847
trans_id in self._new_parent):
1849
mover.rename(full_path, self._limbo_name(trans_id))
1850
except errors.TransformRenameFailed as e:
1851
if e.errno != errno.ENOENT:
1854
self.rename_count += 1
1856
def _apply_insertions(self, mover):
1857
"""Perform tree operations that insert directory/inventory names.
1859
That is, create any files that need to be created, and restore from
1860
limbo any files that needed renaming. This must be done in strict
1861
parent-to-child order.
1863
If inventory_delta is None, no inventory delta is calculated, and
1864
no list of modified paths is returned.
1866
new_paths = self.new_paths(filesystem_only=True)
1868
with ui.ui_factory.nested_progress_bar() as child_pb:
1869
for num, (path, trans_id) in enumerate(new_paths):
1871
child_pb.update(gettext('adding file'),
1872
num, len(new_paths))
1873
full_path = self._tree.abspath(path)
1874
if trans_id in self._needs_rename:
1876
mover.rename(self._limbo_name(trans_id), full_path)
1877
except errors.TransformRenameFailed as e:
1878
# We may be renaming a dangling inventory id
1879
if e.errno != errno.ENOENT:
1882
self.rename_count += 1
1883
# TODO: if trans_id in self._observed_sha1s, we should
1884
# re-stat the final target, since ctime will be
1885
# updated by the change.
1886
if (trans_id in self._new_contents
1887
or self.path_changed(trans_id)):
1888
if trans_id in self._new_contents:
1889
modified_paths.append(full_path)
1890
if trans_id in self._new_executability:
1891
self._set_executability(path, trans_id)
1892
if trans_id in self._observed_sha1s:
1893
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1894
st = osutils.lstat(full_path)
1895
self._observed_sha1s[trans_id] = (o_sha1, st)
1896
for path, trans_id in new_paths:
1897
# new_paths includes stuff like workingtree conflicts. Only the
1898
# stuff in new_contents actually comes from limbo.
1899
if trans_id in self._limbo_files:
1900
del self._limbo_files[trans_id]
1901
self._new_contents.clear()
1902
return modified_paths
1904
def _apply_observed_sha1s(self):
1905
"""After we have finished renaming everything, update observed sha1s
1907
This has to be done after self._tree.apply_inventory_delta, otherwise
1908
it doesn't know anything about the files we are updating. Also, we want
1909
to do this as late as possible, so that most entries end up cached.
1911
# TODO: this doesn't update the stat information for directories. So
1912
# the first 'bzr status' will still need to rewrite
1913
# .bzr/checkout/dirstate. However, we at least don't need to
1914
# re-read all of the files.
1915
# TODO: If the operation took a while, we could do a time.sleep(3) here
1916
# to allow the clock to tick over and ensure we won't have any
1917
# problems. (we could observe start time, and finish time, and if
1918
# it is less than eg 10% overhead, add a sleep call.)
1919
paths = FinalPaths(self)
1920
for trans_id, observed in viewitems(self._observed_sha1s):
1921
path = paths.get_path(trans_id)
1922
self._tree._observed_sha1(path, observed)
1925
class TransformPreview(DiskTreeTransform):
1926
"""A TreeTransform for generating preview trees.
1928
Unlike TreeTransform, this version works when the input tree is a
1929
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1930
unversioned files in the input tree.
1933
def __init__(self, tree, pb=None, case_sensitive=True):
1935
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1936
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1938
def canonical_path(self, path):
1941
def tree_kind(self, trans_id):
1942
path = self._tree_id_paths.get(trans_id)
1945
kind = self._tree.path_content_summary(path)[0]
1946
if kind == 'missing':
1950
def _set_mode(self, trans_id, mode_id, typefunc):
1951
"""Set the mode of new file contents.
1952
The mode_id is the existing file to get the mode from (often the same
1953
as trans_id). The operation is only performed if there's a mode match
1954
according to typefunc.
1956
# is it ok to ignore this? probably
1959
def iter_tree_children(self, parent_id):
1960
"""Iterate through the entry's tree children, if any"""
1962
path = self._tree_id_paths[parent_id]
1966
entry = next(self._tree.iter_entries_by_dir(
1967
specific_files=[path]))[1]
1968
except StopIteration:
1970
children = getattr(entry, 'children', {})
1971
for child in children:
1972
childpath = joinpath(path, child)
1973
yield self.trans_id_tree_path(childpath)
1975
def new_orphan(self, trans_id, parent_id):
1976
raise NotImplementedError(self.new_orphan)
1979
class _PreviewTree(inventorytree.InventoryTree):
1980
"""Partial implementation of Tree to support show_diff_trees"""
1982
def __init__(self, transform):
1983
self._transform = transform
1984
self._final_paths = FinalPaths(transform)
1985
self.__by_parent = None
1986
self._parent_ids = []
1987
self._all_children_cache = {}
1988
self._path2trans_id_cache = {}
1989
self._final_name_cache = {}
1990
self._iter_changes_cache = dict((c[0], c) for c in
1991
self._transform.iter_changes())
1993
def _content_change(self, file_id):
1994
"""Return True if the content of this file changed"""
1995
changes = self._iter_changes_cache.get(file_id)
1996
# changes[2] is true if the file content changed. See
1997
# InterTree.iter_changes.
1998
return (changes is not None and changes[2])
2000
def _get_repository(self):
2001
repo = getattr(self._transform._tree, '_repository', None)
2003
repo = self._transform._tree.branch.repository
2006
def _iter_parent_trees(self):
2007
for revision_id in self.get_parent_ids():
2009
yield self.revision_tree(revision_id)
2010
except errors.NoSuchRevisionInTree:
2011
yield self._get_repository().revision_tree(revision_id)
2013
def _get_file_revision(self, path, file_id, vf, tree_revision):
2015
(file_id, t.get_file_revision(t.id2path(file_id)))
2016
for t in self._iter_parent_trees()]
2017
vf.add_lines((file_id, tree_revision), parent_keys,
2018
self.get_file_lines(path))
2019
repo = self._get_repository()
2020
base_vf = repo.texts
2021
if base_vf not in vf.fallback_versionedfiles:
2022
vf.fallback_versionedfiles.append(base_vf)
2023
return tree_revision
2025
def _stat_limbo_file(self, trans_id):
2026
name = self._transform._limbo_name(trans_id)
2027
return os.lstat(name)
2030
def _by_parent(self):
2031
if self.__by_parent is None:
2032
self.__by_parent = self._transform.by_parent()
2033
return self.__by_parent
2035
def _comparison_data(self, entry, path):
2036
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2037
if kind == 'missing':
2041
file_id = self._transform.final_file_id(self._path2trans_id(path))
2042
executable = self.is_executable(path)
2043
return kind, executable, None
2045
def is_locked(self):
2048
def lock_read(self):
2049
# Perhaps in theory, this should lock the TreeTransform?
2050
return lock.LogicalLockResult(self.unlock)
2056
def root_inventory(self):
2057
"""This Tree does not use inventory as its backing data."""
2058
raise NotImplementedError(_PreviewTree.root_inventory)
2060
def get_root_id(self):
2061
return self._transform.final_file_id(self._transform.root)
2063
def all_file_ids(self):
2064
tree_ids = set(self._transform._tree.all_file_ids())
2065
tree_ids.difference_update(self._transform.tree_file_id(t)
2066
for t in self._transform._removed_id)
2067
tree_ids.update(viewvalues(self._transform._new_id))
2070
def all_versioned_paths(self):
2071
tree_paths = set(self._transform._tree.all_versioned_paths())
2073
tree_paths.difference_update(
2074
self._transform.trans_id_tree_path(t)
2075
for t in self._transform._removed_id)
2078
self._final_paths._determine_path(t)
2079
for t in self._transform._new_id)
2083
def _has_id(self, file_id, fallback_check):
2084
if file_id in self._transform._r_new_id:
2086
elif file_id in {self._transform.tree_file_id(trans_id) for
2087
trans_id in self._transform._removed_id}:
2090
return fallback_check(file_id)
2092
def has_id(self, file_id):
2093
return self._has_id(file_id, self._transform._tree.has_id)
2095
def has_or_had_id(self, file_id):
2096
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2098
def _path2trans_id(self, path):
2099
# We must not use None here, because that is a valid value to store.
2100
trans_id = self._path2trans_id_cache.get(path, object)
2101
if trans_id is not object:
2103
segments = splitpath(path)
2104
cur_parent = self._transform.root
2105
for cur_segment in segments:
2106
for child in self._all_children(cur_parent):
2107
final_name = self._final_name_cache.get(child)
2108
if final_name is None:
2109
final_name = self._transform.final_name(child)
2110
self._final_name_cache[child] = final_name
2111
if final_name == cur_segment:
2115
self._path2trans_id_cache[path] = None
2117
self._path2trans_id_cache[path] = cur_parent
2120
def path2id(self, path):
2121
if isinstance(path, list):
2124
path = osutils.pathjoin(*path)
2125
return self._transform.final_file_id(self._path2trans_id(path))
2127
def id2path(self, file_id):
2128
trans_id = self._transform.trans_id_file_id(file_id)
2130
return self._final_paths._determine_path(trans_id)
2132
raise errors.NoSuchId(self, file_id)
2134
def _all_children(self, trans_id):
2135
children = self._all_children_cache.get(trans_id)
2136
if children is not None:
2138
children = set(self._transform.iter_tree_children(trans_id))
2139
# children in the _new_parent set are provided by _by_parent.
2140
children.difference_update(self._transform._new_parent)
2141
children.update(self._by_parent.get(trans_id, []))
2142
self._all_children_cache[trans_id] = children
2145
def _iter_children(self, file_id):
2146
trans_id = self._transform.trans_id_file_id(file_id)
2147
for child_trans_id in self._all_children(trans_id):
2148
yield self._transform.final_file_id(child_trans_id)
2151
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2152
in self._transform._tree.extras())
2153
possible_extras.update(self._transform._new_contents)
2154
possible_extras.update(self._transform._removed_id)
2155
for trans_id in possible_extras:
2156
if self._transform.final_file_id(trans_id) is None:
2157
yield self._final_paths._determine_path(trans_id)
2159
def _make_inv_entries(self, ordered_entries, specific_files=None):
2160
for trans_id, parent_file_id in ordered_entries:
2161
file_id = self._transform.final_file_id(trans_id)
2164
if (specific_files is not None
2165
and self._final_paths.get_path(trans_id) not in specific_files):
2167
kind = self._transform.final_kind(trans_id)
2169
kind = self._transform._tree.stored_kind(
2170
self._transform._tree.id2path(file_id),
2172
new_entry = inventory.make_entry(
2174
self._transform.final_name(trans_id),
2175
parent_file_id, file_id)
2176
yield new_entry, trans_id
2178
def _list_files_by_dir(self):
2179
todo = [ROOT_PARENT]
2181
while len(todo) > 0:
2183
parent_file_id = self._transform.final_file_id(parent)
2184
children = list(self._all_children(parent))
2185
paths = dict(zip(children, self._final_paths.get_paths(children)))
2186
children.sort(key=paths.get)
2187
todo.extend(reversed(children))
2188
for trans_id in children:
2189
ordered_ids.append((trans_id, parent_file_id))
2192
def iter_child_entries(self, path):
2193
trans_id = self._path2trans_id(path)
2194
if trans_id is None:
2195
raise errors.NoSuchFile(path)
2196
todo = [(child_trans_id, trans_id) for child_trans_id in
2197
self._all_children(trans_id)]
2198
for entry, trans_id in self._make_inv_entries(todo):
2201
def iter_entries_by_dir(self, specific_files=None):
2202
# This may not be a maximally efficient implementation, but it is
2203
# reasonably straightforward. An implementation that grafts the
2204
# TreeTransform changes onto the tree's iter_entries_by_dir results
2205
# might be more efficient, but requires tricky inferences about stack
2207
ordered_ids = self._list_files_by_dir()
2208
for entry, trans_id in self._make_inv_entries(ordered_ids,
2210
yield self._final_paths.get_path(trans_id), entry
2212
def _iter_entries_for_dir(self, dir_path):
2213
"""Return path, entry for items in a directory without recursing down."""
2215
dir_trans_id = self._path2trans_id(dir_path)
2216
dir_id = self._transform.final_file_id(dir_trans_id)
2217
for child_trans_id in self._all_children(dir_trans_id):
2218
ordered_ids.append((child_trans_id, dir_id))
2220
for entry, trans_id in self._make_inv_entries(ordered_ids):
2221
path_entries.append((self._final_paths.get_path(trans_id), entry))
2225
def list_files(self, include_root=False, from_dir=None, recursive=True):
2226
"""See WorkingTree.list_files."""
2227
# XXX This should behave like WorkingTree.list_files, but is really
2228
# more like RevisionTree.list_files.
2234
prefix = from_dir + '/'
2235
entries = self.iter_entries_by_dir()
2236
for path, entry in entries:
2237
if entry.name == '' and not include_root:
2240
if not path.startswith(prefix):
2242
path = path[len(prefix):]
2243
yield path, 'V', entry.kind, entry.file_id, entry
2245
if from_dir is None and include_root is True:
2246
root_entry = inventory.make_entry('directory', '',
2247
ROOT_PARENT, self.get_root_id())
2248
yield '', 'V', 'directory', root_entry.file_id, root_entry
2249
entries = self._iter_entries_for_dir(from_dir or '')
2250
for path, entry in entries:
2251
yield path, 'V', entry.kind, entry.file_id, entry
2253
def kind(self, path):
2254
trans_id = self._path2trans_id(path)
2255
if trans_id is None:
2256
raise errors.NoSuchFile(path)
2257
return self._transform.final_kind(trans_id)
2259
def stored_kind(self, path):
2260
trans_id = self._path2trans_id(path)
2261
if trans_id is None:
2262
raise errors.NoSuchFile(path)
2264
return self._transform._new_contents[trans_id]
2266
return self._transform._tree.stored_kind(path)
2268
def get_file_mtime(self, path):
2269
"""See Tree.get_file_mtime"""
2270
file_id = self.path2id(path)
2272
raise errors.NoSuchFile(path)
2273
if not self._content_change(file_id):
2274
return self._transform._tree.get_file_mtime(
2275
self._transform._tree.id2path(file_id))
2276
trans_id = self._path2trans_id(path)
2277
return self._stat_limbo_file(trans_id).st_mtime
2279
def get_file_size(self, path):
2280
"""See Tree.get_file_size"""
2281
trans_id = self._path2trans_id(path)
2282
if trans_id is None:
2283
raise errors.NoSuchFile(path)
2284
kind = self._transform.final_kind(trans_id)
2287
if trans_id in self._transform._new_contents:
2288
return self._stat_limbo_file(trans_id).st_size
2289
if self.kind(path) == 'file':
2290
return self._transform._tree.get_file_size(path)
2294
def get_file_verifier(self, path, stat_value=None):
2295
trans_id = self._path2trans_id(path)
2296
if trans_id is None:
2297
raise errors.NoSuchFile(path)
2298
kind = self._transform._new_contents.get(trans_id)
2300
return self._transform._tree.get_file_verifier(path)
2302
with self.get_file(path) as fileobj:
2303
return ("SHA1", sha_file(fileobj))
2305
def get_file_sha1(self, path, stat_value=None):
2306
trans_id = self._path2trans_id(path)
2307
if trans_id is None:
2308
raise errors.NoSuchFile(path)
2309
kind = self._transform._new_contents.get(trans_id)
2311
return self._transform._tree.get_file_sha1(path)
2313
with self.get_file(path) as fileobj:
2314
return sha_file(fileobj)
2316
def is_executable(self, path):
2317
trans_id = self._path2trans_id(path)
2318
if trans_id is None:
2321
return self._transform._new_executability[trans_id]
2324
return self._transform._tree.is_executable(path)
2325
except OSError as e:
2326
if e.errno == errno.ENOENT:
2329
except errors.NoSuchFile:
2332
def has_filename(self, path):
2333
trans_id = self._path2trans_id(path)
2334
if trans_id in self._transform._new_contents:
2336
elif trans_id in self._transform._removed_contents:
2339
return self._transform._tree.has_filename(path)
2341
def path_content_summary(self, path):
2342
trans_id = self._path2trans_id(path)
2343
tt = self._transform
2344
tree_path = tt._tree_id_paths.get(trans_id)
2345
kind = tt._new_contents.get(trans_id)
2347
if tree_path is None or trans_id in tt._removed_contents:
2348
return 'missing', None, None, None
2349
summary = tt._tree.path_content_summary(tree_path)
2350
kind, size, executable, link_or_sha1 = summary
2353
limbo_name = tt._limbo_name(trans_id)
2354
if trans_id in tt._new_reference_revision:
2355
kind = 'tree-reference'
2357
statval = os.lstat(limbo_name)
2358
size = statval.st_size
2359
if not tt._limbo_supports_executable():
2362
executable = statval.st_mode & S_IEXEC
2366
if kind == 'symlink':
2367
link_or_sha1 = os.readlink(limbo_name)
2368
if not isinstance(link_or_sha1, text_type):
2369
link_or_sha1 = link_or_sha1.decode(osutils._fs_enc)
2370
executable = tt._new_executability.get(trans_id, executable)
2371
return kind, size, executable, link_or_sha1
2373
def iter_changes(self, from_tree, include_unchanged=False,
2374
specific_files=None, pb=None, extra_trees=None,
2375
require_versioned=True, want_unversioned=False):
2376
"""See InterTree.iter_changes.
2378
This has a fast path that is only used when the from_tree matches
2379
the transform tree, and no fancy options are supplied.
2381
if (from_tree is not self._transform._tree or include_unchanged
2382
or specific_files or want_unversioned):
2383
return tree.InterTree(from_tree, self).iter_changes(
2384
include_unchanged=include_unchanged,
2385
specific_files=specific_files,
2387
extra_trees=extra_trees,
2388
require_versioned=require_versioned,
2389
want_unversioned=want_unversioned)
2390
if want_unversioned:
2391
raise ValueError('want_unversioned is not supported')
2392
return self._transform.iter_changes()
2394
def get_file(self, path):
2395
"""See Tree.get_file"""
2396
file_id = self.path2id(path)
2397
if not self._content_change(file_id):
2398
return self._transform._tree.get_file(path)
2399
trans_id = self._path2trans_id(path)
2400
name = self._transform._limbo_name(trans_id)
2401
return open(name, 'rb')
2403
def get_file_with_stat(self, path):
2404
return self.get_file(path), None
2406
def annotate_iter(self, path,
2407
default_revision=_mod_revision.CURRENT_REVISION):
2408
file_id = self.path2id(path)
2409
changes = self._iter_changes_cache.get(file_id)
2413
changed_content, versioned, kind = (changes[2], changes[3],
2417
get_old = (kind[0] == 'file' and versioned[0])
2419
old_annotation = self._transform._tree.annotate_iter(
2420
path, default_revision=default_revision)
2424
return old_annotation
2425
if not changed_content:
2426
return old_annotation
2427
# TODO: This is doing something similar to what WT.annotate_iter is
2428
# doing, however it fails slightly because it doesn't know what
2429
# the *other* revision_id is, so it doesn't know how to give the
2430
# other as the origin for some lines, they all get
2431
# 'default_revision'
2432
# It would be nice to be able to use the new Annotator based
2433
# approach, as well.
2434
return annotate.reannotate([old_annotation],
2435
self.get_file(path).readlines(),
2438
def get_symlink_target(self, path):
2439
"""See Tree.get_symlink_target"""
2440
file_id = self.path2id(path)
2441
if not self._content_change(file_id):
2442
return self._transform._tree.get_symlink_target(path)
2443
trans_id = self._path2trans_id(path)
2444
name = self._transform._limbo_name(trans_id)
2445
return osutils.readlink(name)
2447
def walkdirs(self, prefix=''):
2448
pending = [self._transform.root]
2449
while len(pending) > 0:
2450
parent_id = pending.pop()
2453
prefix = prefix.rstrip('/')
2454
parent_path = self._final_paths.get_path(parent_id)
2455
parent_file_id = self._transform.final_file_id(parent_id)
2456
for child_id in self._all_children(parent_id):
2457
path_from_root = self._final_paths.get_path(child_id)
2458
basename = self._transform.final_name(child_id)
2459
file_id = self._transform.final_file_id(child_id)
2460
kind = self._transform.final_kind(child_id)
2461
if kind is not None:
2462
versioned_kind = kind
2465
versioned_kind = self._transform._tree.stored_kind(
2466
self._transform._tree.id2path(file_id))
2467
if versioned_kind == 'directory':
2468
subdirs.append(child_id)
2469
children.append((path_from_root, basename, kind, None,
2470
file_id, versioned_kind))
2472
if parent_path.startswith(prefix):
2473
yield (parent_path, parent_file_id), children
2474
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2477
def get_parent_ids(self):
2478
return self._parent_ids
2480
def set_parent_ids(self, parent_ids):
2481
self._parent_ids = parent_ids
2483
def get_revision_tree(self, revision_id):
2484
return self._transform._tree.get_revision_tree(revision_id)
2487
def joinpath(parent, child):
2488
"""Join tree-relative paths, handling the tree root specially"""
2489
if parent is None or parent == "":
2492
return pathjoin(parent, child)
2495
class FinalPaths(object):
2496
"""Make path calculation cheap by memoizing paths.
2498
The underlying tree must not be manipulated between calls, or else
2499
the results will likely be incorrect.
2502
def __init__(self, transform):
2503
object.__init__(self)
2504
self._known_paths = {}
2505
self.transform = transform
2507
def _determine_path(self, trans_id):
2508
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2510
name = self.transform.final_name(trans_id)
2511
parent_id = self.transform.final_parent(trans_id)
2512
if parent_id == self.transform.root:
2515
return pathjoin(self.get_path(parent_id), name)
2517
def get_path(self, trans_id):
2518
"""Find the final path associated with a trans_id"""
2519
if trans_id not in self._known_paths:
2520
self._known_paths[trans_id] = self._determine_path(trans_id)
2521
return self._known_paths[trans_id]
2523
def get_paths(self, trans_ids):
2524
return [(self.get_path(t), t) for t in trans_ids]
2527
def topology_sorted_ids(tree):
2528
"""Determine the topological order of the ids in a tree"""
2529
file_ids = list(tree)
2530
file_ids.sort(key=tree.id2path)
2534
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2535
delta_from_tree=False):
2536
"""Create working tree for a branch, using a TreeTransform.
2538
This function should be used on empty trees, having a tree root at most.
2539
(see merge and revert functionality for working with existing trees)
2541
Existing files are handled like so:
2543
- Existing bzrdirs take precedence over creating new items. They are
2544
created as '%s.diverted' % name.
2545
- Otherwise, if the content on disk matches the content we are building,
2546
it is silently replaced.
2547
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2549
:param tree: The tree to convert wt into a copy of
2550
:param wt: The working tree that files will be placed into
2551
:param accelerator_tree: A tree which can be used for retrieving file
2552
contents more quickly than tree itself, i.e. a workingtree. tree
2553
will be used for cases where accelerator_tree's content is different.
2554
:param hardlink: If true, hard-link files to accelerator_tree, where
2555
possible. accelerator_tree must implement abspath, i.e. be a
2557
:param delta_from_tree: If true, build_tree may use the input Tree to
2558
generate the inventory delta.
2560
with wt.lock_tree_write(), tree.lock_read():
2561
if accelerator_tree is not None:
2562
accelerator_tree.lock_read()
2564
return _build_tree(tree, wt, accelerator_tree, hardlink,
2567
if accelerator_tree is not None:
2568
accelerator_tree.unlock()
2571
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2572
"""See build_tree."""
2573
for num, _unused in enumerate(wt.all_versioned_paths()):
2574
if num > 0: # more than just a root
2575
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2577
top_pb = ui.ui_factory.nested_progress_bar()
2578
pp = ProgressPhase("Build phase", 2, top_pb)
2579
if tree.get_root_id() is not None:
2580
# This is kind of a hack: we should be altering the root
2581
# as part of the regular tree shape diff logic.
2582
# The conditional test here is to avoid doing an
2583
# expensive operation (flush) every time the root id
2584
# is set within the tree, nor setting the root and thus
2585
# marking the tree as dirty, because we use two different
2586
# idioms here: tree interfaces and inventory interfaces.
2587
if wt.get_root_id() != tree.get_root_id():
2588
wt.set_root_id(tree.get_root_id())
2590
tt = TreeTransform(wt)
2594
file_trans_id[wt.get_root_id()] = tt.trans_id_tree_path('')
2595
with ui.ui_factory.nested_progress_bar() as pb:
2596
deferred_contents = []
2598
total = len(tree.all_versioned_paths())
2600
precomputed_delta = []
2602
precomputed_delta = None
2603
# Check if tree inventory has content. If so, we populate
2604
# existing_files with the directory content. If there are no
2605
# entries we skip populating existing_files as its not used.
2606
# This improves performance and unncessary work on large
2607
# directory trees. (#501307)
2609
existing_files = set()
2610
for dir, files in wt.walkdirs():
2611
existing_files.update(f[0] for f in files)
2612
for num, (tree_path, entry) in \
2613
enumerate(tree.iter_entries_by_dir()):
2614
pb.update(gettext("Building tree"), num
2615
- len(deferred_contents), total)
2616
if entry.parent_id is None:
2619
file_id = entry.file_id
2621
precomputed_delta.append((None, tree_path, file_id, entry))
2622
if tree_path in existing_files:
2623
target_path = wt.abspath(tree_path)
2624
kind = file_kind(target_path)
2625
if kind == "directory":
2627
controldir.ControlDir.open(target_path)
2628
except errors.NotBranchError:
2632
if (file_id not in divert
2634
tree, entry, tree_path, file_id, kind,
2636
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2637
if kind == 'directory':
2639
parent_id = file_trans_id[entry.parent_id]
2640
if entry.kind == 'file':
2641
# We *almost* replicate new_by_entry, so that we can defer
2642
# getting the file text, and get them all at once.
2643
trans_id = tt.create_path(entry.name, parent_id)
2644
file_trans_id[file_id] = trans_id
2645
tt.version_file(file_id, trans_id)
2646
executable = tree.is_executable(tree_path)
2648
tt.set_executability(executable, trans_id)
2649
trans_data = (trans_id, file_id,
2650
tree_path, entry.text_sha1)
2651
deferred_contents.append((tree_path, trans_data))
2653
file_trans_id[file_id] = new_by_entry(
2654
tree_path, tt, entry, parent_id, tree)
2656
new_trans_id = file_trans_id[file_id]
2657
old_parent = tt.trans_id_tree_path(tree_path)
2658
_reparent_children(tt, old_parent, new_trans_id)
2659
offset = num + 1 - len(deferred_contents)
2660
_create_files(tt, tree, deferred_contents, pb, offset,
2661
accelerator_tree, hardlink)
2663
divert_trans = set(file_trans_id[f] for f in divert)
2666
return resolve_checkout(t, c, divert_trans)
2667
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2668
if len(raw_conflicts) > 0:
2669
precomputed_delta = None
2670
conflicts = cook_conflicts(raw_conflicts, tt)
2671
for conflict in conflicts:
2672
trace.warning(text_type(conflict))
2674
wt.add_conflicts(conflicts)
2675
except errors.UnsupportedOperation:
2677
result = tt.apply(no_conflicts=True,
2678
precomputed_delta=precomputed_delta)
2685
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2687
total = len(desired_files) + offset
2689
if accelerator_tree is None:
2690
new_desired_files = desired_files
2692
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2693
unchanged = [(p[0], p[1]) for (f, p, c, v, d, n, k, e)
2694
in iter if not (c or e[0] != e[1])]
2695
if accelerator_tree.supports_content_filtering():
2696
unchanged = [(tp, ap) for (tp, ap) in unchanged
2697
if not next(accelerator_tree.iter_search_rules([ap]))]
2698
unchanged = dict(unchanged)
2699
new_desired_files = []
2701
for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
2702
accelerator_path = unchanged.get(tree_path)
2703
if accelerator_path is None:
2704
new_desired_files.append((tree_path,
2705
(trans_id, file_id, tree_path, text_sha1)))
2707
pb.update(gettext('Adding file contents'), count + offset, total)
2709
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2712
with accelerator_tree.get_file(accelerator_path, file_id) as f:
2713
chunks = osutils.file_iterator(f)
2714
if wt.supports_content_filtering():
2715
filters = wt._content_filter_stack(tree_path)
2716
chunks = filtered_output_bytes(chunks, filters,
2717
ContentFilterContext(tree_path, tree))
2718
tt.create_file(chunks, trans_id, sha1=text_sha1)
2721
for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
2722
tree.iter_files_bytes(new_desired_files)):
2723
if wt.supports_content_filtering():
2724
filters = wt._content_filter_stack(tree_path)
2725
contents = filtered_output_bytes(contents, filters,
2726
ContentFilterContext(tree_path, tree))
2727
tt.create_file(contents, trans_id, sha1=text_sha1)
2728
pb.update(gettext('Adding file contents'), count + offset, total)
2731
def _reparent_children(tt, old_parent, new_parent):
2732
for child in tt.iter_tree_children(old_parent):
2733
tt.adjust_path(tt.final_name(child), new_parent, child)
2736
def _reparent_transform_children(tt, old_parent, new_parent):
2737
by_parent = tt.by_parent()
2738
for child in by_parent[old_parent]:
2739
tt.adjust_path(tt.final_name(child), new_parent, child)
2740
return by_parent[old_parent]
2743
def _content_match(tree, entry, tree_path, file_id, kind, target_path):
2744
if entry.kind != kind:
2746
if entry.kind == "directory":
2748
if entry.kind == "file":
2749
with open(target_path, 'rb') as f1, \
2750
tree.get_file(tree_path) as f2:
2751
if osutils.compare_files(f1, f2):
2753
elif entry.kind == "symlink":
2754
if tree.get_symlink_target(tree_path) == os.readlink(target_path):
2759
def resolve_checkout(tt, conflicts, divert):
2760
new_conflicts = set()
2761
for c_type, conflict in ((c[0], c) for c in conflicts):
2762
# Anything but a 'duplicate' would indicate programmer error
2763
if c_type != 'duplicate':
2764
raise AssertionError(c_type)
2765
# Now figure out which is new and which is old
2766
if tt.new_contents(conflict[1]):
2767
new_file = conflict[1]
2768
old_file = conflict[2]
2770
new_file = conflict[2]
2771
old_file = conflict[1]
2773
# We should only get here if the conflict wasn't completely
2775
final_parent = tt.final_parent(old_file)
2776
if new_file in divert:
2777
new_name = tt.final_name(old_file) + '.diverted'
2778
tt.adjust_path(new_name, final_parent, new_file)
2779
new_conflicts.add((c_type, 'Diverted to',
2780
new_file, old_file))
2782
new_name = tt.final_name(old_file) + '.moved'
2783
tt.adjust_path(new_name, final_parent, old_file)
2784
new_conflicts.add((c_type, 'Moved existing file to',
2785
old_file, new_file))
2786
return new_conflicts
2789
def new_by_entry(path, tt, entry, parent_id, tree):
2790
"""Create a new file according to its inventory entry"""
2794
with tree.get_file(path) as f:
2795
executable = tree.is_executable(path)
2797
name, parent_id, osutils.file_iterator(f), entry.file_id,
2799
elif kind in ('directory', 'tree-reference'):
2800
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2801
if kind == 'tree-reference':
2802
tt.set_tree_reference(entry.reference_revision, trans_id)
2804
elif kind == 'symlink':
2805
target = tree.get_symlink_target(path)
2806
return tt.new_symlink(name, parent_id, target, entry.file_id)
2808
raise errors.BadFileKindError(name, kind)
2811
def create_from_tree(tt, trans_id, tree, path, file_id=None, chunks=None,
2812
filter_tree_path=None):
2813
"""Create new file contents according to tree contents.
2815
:param filter_tree_path: the tree path to use to lookup
2816
content filters to apply to the bytes output in the working tree.
2817
This only applies if the working tree supports content filtering.
2819
kind = tree.kind(path)
2820
if kind == 'directory':
2821
tt.create_directory(trans_id)
2822
elif kind == "file":
2824
f = tree.get_file(path)
2825
chunks = osutils.file_iterator(f)
2830
if wt.supports_content_filtering() and filter_tree_path is not None:
2831
filters = wt._content_filter_stack(filter_tree_path)
2832
chunks = filtered_output_bytes(
2834
ContentFilterContext(filter_tree_path, tree))
2835
tt.create_file(chunks, trans_id)
2839
elif kind == "symlink":
2840
tt.create_symlink(tree.get_symlink_target(path), trans_id)
2842
raise AssertionError('Unknown kind %r' % kind)
2845
def create_entry_executability(tt, entry, trans_id):
2846
"""Set the executability of a trans_id according to an inventory entry"""
2847
if entry.kind == "file":
2848
tt.set_executability(entry.executable, trans_id)
2851
def revert(working_tree, target_tree, filenames, backups=False,
2852
pb=None, change_reporter=None):
2853
"""Revert a working tree's contents to those of a target tree."""
2854
pb = ui.ui_factory.nested_progress_bar()
2856
with target_tree.lock_read(), TreeTransform(working_tree, pb) as tt:
2857
pp = ProgressPhase("Revert phase", 3, pb)
2858
conflicts, merge_modified = _prepare_revert_transform(
2859
working_tree, target_tree, tt, filenames, backups, pp)
2861
change_reporter = delta._ChangeReporter(
2862
unversioned_filter=working_tree.is_ignored)
2863
delta.report_changes(tt.iter_changes(), change_reporter)
2864
for conflict in conflicts:
2865
trace.warning(text_type(conflict))
2868
if working_tree.supports_merge_modified():
2869
working_tree.set_merge_modified(merge_modified)
2875
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2876
backups, pp, basis_tree=None,
2877
merge_modified=None):
2878
with ui.ui_factory.nested_progress_bar() as child_pb:
2879
if merge_modified is None:
2880
merge_modified = working_tree.merge_modified()
2881
merge_modified = _alter_files(working_tree, target_tree, tt,
2882
child_pb, filenames, backups,
2883
merge_modified, basis_tree)
2884
with ui.ui_factory.nested_progress_bar() as child_pb:
2885
raw_conflicts = resolve_conflicts(
2886
tt, child_pb, lambda t, c: conflict_pass(t, c, target_tree))
2887
conflicts = cook_conflicts(raw_conflicts, tt)
2888
return conflicts, merge_modified
2891
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2892
backups, merge_modified, basis_tree=None):
2893
if basis_tree is not None:
2894
basis_tree.lock_read()
2895
# We ask the working_tree for its changes relative to the target, rather
2896
# than the target changes relative to the working tree. Because WT4 has an
2897
# optimizer to compare itself to a target, but no optimizer for the
2899
change_list = working_tree.iter_changes(
2900
target_tree, specific_files=specific_files, pb=pb)
2901
if not target_tree.is_versioned(u''):
2907
for id_num, (file_id, path, changed_content, versioned, parent, name,
2908
kind, executable) in enumerate(change_list):
2909
target_path, wt_path = path
2910
target_versioned, wt_versioned = versioned
2911
target_parent, wt_parent = parent
2912
target_name, wt_name = name
2913
target_kind, wt_kind = kind
2914
target_executable, wt_executable = executable
2915
if skip_root and wt_parent is None:
2917
trans_id = tt.trans_id_file_id(file_id)
2920
keep_content = False
2921
if wt_kind == 'file' and (backups or target_kind is None):
2922
wt_sha1 = working_tree.get_file_sha1(wt_path)
2923
if merge_modified.get(file_id) != wt_sha1:
2924
# acquire the basis tree lazily to prevent the
2925
# expense of accessing it when it's not needed ?
2926
# (Guessing, RBC, 200702)
2927
if basis_tree is None:
2928
basis_tree = working_tree.basis_tree()
2929
basis_tree.lock_read()
2930
basis_path = find_previous_path(
2931
working_tree, basis_tree, wt_path)
2932
if basis_path is None:
2933
if target_kind is None and not target_versioned:
2936
if wt_sha1 != basis_tree.get_file_sha1(basis_path):
2938
if wt_kind is not None:
2939
if not keep_content:
2940
tt.delete_contents(trans_id)
2941
elif target_kind is not None:
2942
parent_trans_id = tt.trans_id_file_id(wt_parent)
2943
backup_name = tt._available_backup_name(
2944
wt_name, parent_trans_id)
2945
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2946
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2947
if wt_versioned and target_versioned:
2948
tt.unversion_file(trans_id)
2949
tt.version_file(file_id, new_trans_id)
2950
# New contents should have the same unix perms as old
2953
trans_id = new_trans_id
2954
if target_kind in ('directory', 'tree-reference'):
2955
tt.create_directory(trans_id)
2956
if target_kind == 'tree-reference':
2957
revision = target_tree.get_reference_revision(
2959
tt.set_tree_reference(revision, trans_id)
2960
elif target_kind == 'symlink':
2961
tt.create_symlink(target_tree.get_symlink_target(
2962
target_path), trans_id)
2963
elif target_kind == 'file':
2964
deferred_files.append(
2965
(target_path, (trans_id, mode_id, file_id)))
2966
if basis_tree is None:
2967
basis_tree = working_tree.basis_tree()
2968
basis_tree.lock_read()
2969
new_sha1 = target_tree.get_file_sha1(target_path)
2970
basis_path = find_previous_path(target_tree, basis_tree, target_path)
2971
if (basis_path is not None and
2972
new_sha1 == basis_tree.get_file_sha1(basis_path)):
2973
if file_id in merge_modified:
2974
del merge_modified[file_id]
2976
merge_modified[file_id] = new_sha1
2978
# preserve the execute bit when backing up
2979
if keep_content and wt_executable == target_executable:
2980
tt.set_executability(target_executable, trans_id)
2981
elif target_kind is not None:
2982
raise AssertionError(target_kind)
2983
if not wt_versioned and target_versioned:
2984
tt.version_file(file_id, trans_id)
2985
if wt_versioned and not target_versioned:
2986
tt.unversion_file(trans_id)
2987
if (target_name is not None
2988
and (wt_name != target_name or wt_parent != target_parent)):
2989
if target_name == '' and target_parent is None:
2990
parent_trans = ROOT_PARENT
2992
parent_trans = tt.trans_id_file_id(target_parent)
2993
if wt_parent is None and wt_versioned:
2994
tt.adjust_root_path(target_name, parent_trans)
2996
tt.adjust_path(target_name, parent_trans, trans_id)
2997
if wt_executable != target_executable and target_kind == "file":
2998
tt.set_executability(target_executable, trans_id)
2999
if working_tree.supports_content_filtering():
3000
for (trans_id, mode_id, file_id), bytes in (
3001
target_tree.iter_files_bytes(deferred_files)):
3002
# We're reverting a tree to the target tree so using the
3003
# target tree to find the file path seems the best choice
3004
# here IMO - Ian C 27/Oct/2009
3005
filter_tree_path = target_tree.id2path(file_id)
3006
filters = working_tree._content_filter_stack(filter_tree_path)
3007
bytes = filtered_output_bytes(
3009
ContentFilterContext(filter_tree_path, working_tree))
3010
tt.create_file(bytes, trans_id, mode_id)
3012
for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
3014
tt.create_file(bytes, trans_id, mode_id)
3015
tt.fixup_new_roots()
3017
if basis_tree is not None:
3019
return merge_modified
3022
def resolve_conflicts(tt, pb=None, pass_func=None):
3023
"""Make many conflict-resolution attempts, but die if they fail"""
3024
if pass_func is None:
3025
pass_func = conflict_pass
3026
new_conflicts = set()
3027
with ui.ui_factory.nested_progress_bar() as pb:
3029
pb.update(gettext('Resolution pass'), n + 1, 10)
3030
conflicts = tt.find_conflicts()
3031
if len(conflicts) == 0:
3032
return new_conflicts
3033
new_conflicts.update(pass_func(tt, conflicts))
3034
raise MalformedTransform(conflicts=conflicts)
3037
def conflict_pass(tt, conflicts, path_tree=None):
3038
"""Resolve some classes of conflicts.
3040
:param tt: The transform to resolve conflicts in
3041
:param conflicts: The conflicts to resolve
3042
:param path_tree: A Tree to get supplemental paths from
3044
new_conflicts = set()
3045
for c_type, conflict in ((c[0], c) for c in conflicts):
3046
if c_type == 'duplicate id':
3047
tt.unversion_file(conflict[1])
3048
new_conflicts.add((c_type, 'Unversioned existing file',
3049
conflict[1], conflict[2], ))
3050
elif c_type == 'duplicate':
3051
# files that were renamed take precedence
3052
final_parent = tt.final_parent(conflict[1])
3053
if tt.path_changed(conflict[1]):
3054
existing_file, new_file = conflict[2], conflict[1]
3056
existing_file, new_file = conflict[1], conflict[2]
3057
new_name = tt.final_name(existing_file) + '.moved'
3058
tt.adjust_path(new_name, final_parent, existing_file)
3059
new_conflicts.add((c_type, 'Moved existing file to',
3060
existing_file, new_file))
3061
elif c_type == 'parent loop':
3062
# break the loop by undoing one of the ops that caused the loop
3064
while not tt.path_changed(cur):
3065
cur = tt.final_parent(cur)
3066
new_conflicts.add((c_type, 'Cancelled move', cur,
3067
tt.final_parent(cur),))
3068
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3070
elif c_type == 'missing parent':
3071
trans_id = conflict[1]
3072
if trans_id in tt._removed_contents:
3073
cancel_deletion = True
3074
orphans = tt._get_potential_orphans(trans_id)
3076
cancel_deletion = False
3077
# All children are orphans
3080
tt.new_orphan(o, trans_id)
3081
except OrphaningError:
3082
# Something bad happened so we cancel the directory
3083
# deletion which will leave it in place with a
3084
# conflict. The user can deal with it from there.
3085
# Note that this also catch the case where we don't
3086
# want to create orphans and leave the directory in
3088
cancel_deletion = True
3091
# Cancel the directory deletion
3092
tt.cancel_deletion(trans_id)
3093
new_conflicts.add(('deleting parent', 'Not deleting',
3098
tt.final_name(trans_id)
3100
if path_tree is not None:
3101
file_id = tt.final_file_id(trans_id)
3103
file_id = tt.inactive_file_id(trans_id)
3104
_, entry = next(path_tree.iter_entries_by_dir(
3105
specific_files=[path_tree.id2path(file_id)]))
3106
# special-case the other tree root (move its
3107
# children to current root)
3108
if entry.parent_id is None:
3110
moved = _reparent_transform_children(
3111
tt, trans_id, tt.root)
3113
new_conflicts.add((c_type, 'Moved to root',
3116
parent_trans_id = tt.trans_id_file_id(
3118
tt.adjust_path(entry.name, parent_trans_id,
3121
tt.create_directory(trans_id)
3122
new_conflicts.add((c_type, 'Created directory', trans_id))
3123
elif c_type == 'unversioned parent':
3124
file_id = tt.inactive_file_id(conflict[1])
3125
# special-case the other tree root (move its children instead)
3126
if path_tree and path_tree.path2id('') == file_id:
3127
# This is the root entry, skip it
3129
tt.version_file(file_id, conflict[1])
3130
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3131
elif c_type == 'non-directory parent':
3132
parent_id = conflict[1]
3133
parent_parent = tt.final_parent(parent_id)
3134
parent_name = tt.final_name(parent_id)
3135
parent_file_id = tt.final_file_id(parent_id)
3136
new_parent_id = tt.new_directory(parent_name + '.new',
3137
parent_parent, parent_file_id)
3138
_reparent_transform_children(tt, parent_id, new_parent_id)
3139
if parent_file_id is not None:
3140
tt.unversion_file(parent_id)
3141
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3142
elif c_type == 'versioning no contents':
3143
tt.cancel_versioning(conflict[1])
3144
return new_conflicts
3147
def cook_conflicts(raw_conflicts, tt):
3148
"""Generate a list of cooked conflicts, sorted by file path"""
3149
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3150
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3153
def iter_cook_conflicts(raw_conflicts, tt):
3155
for conflict in raw_conflicts:
3156
c_type = conflict[0]
3157
action = conflict[1]
3158
modified_path = fp.get_path(conflict[2])
3159
modified_id = tt.final_file_id(conflict[2])
3160
if len(conflict) == 3:
3161
yield conflicts.Conflict.factory(
3162
c_type, action=action, path=modified_path, file_id=modified_id)
3165
conflicting_path = fp.get_path(conflict[3])
3166
conflicting_id = tt.final_file_id(conflict[3])
3167
yield conflicts.Conflict.factory(
3168
c_type, action=action, path=modified_path,
3169
file_id=modified_id,
3170
conflict_path=conflicting_path,
3171
conflict_file_id=conflicting_id)
3174
class _FileMover(object):
3175
"""Moves and deletes files for TreeTransform, tracking operations"""
3178
self.past_renames = []
3179
self.pending_deletions = []
3181
def rename(self, from_, to):
3182
"""Rename a file from one path to another."""
3184
os.rename(from_, to)
3185
except OSError as e:
3186
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3187
raise errors.FileExists(to, str(e))
3188
# normal OSError doesn't include filenames so it's hard to see where
3189
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3190
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3191
self.past_renames.append((from_, to))
3193
def pre_delete(self, from_, to):
3194
"""Rename a file out of the way and mark it for deletion.
3196
Unlike os.unlink, this works equally well for files and directories.
3197
:param from_: The current file path
3198
:param to: A temporary path for the file
3200
self.rename(from_, to)
3201
self.pending_deletions.append(to)
3204
"""Reverse all renames that have been performed"""
3205
for from_, to in reversed(self.past_renames):
3207
os.rename(to, from_)
3208
except OSError as e:
3209
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3210
# after rollback, don't reuse _FileMover
3211
self.past_renames = None
3212
self.pending_deletions = None
3214
def apply_deletions(self):
3215
"""Apply all marked deletions"""
3216
for path in self.pending_deletions:
3218
# after apply_deletions, don't reuse _FileMover
3219
self.past_renames = None
3220
self.pending_deletions = None
3223
def link_tree(target_tree, source_tree):
3224
"""Where possible, hard-link files in a tree to those in another tree.
3226
:param target_tree: Tree to change
3227
:param source_tree: Tree to hard-link from
3229
tt = TreeTransform(target_tree)
3231
for (file_id, paths, changed_content, versioned, parent, name, kind,
3232
executable) in target_tree.iter_changes(source_tree,
3233
include_unchanged=True):
3236
if kind != ('file', 'file'):
3238
if executable[0] != executable[1]:
3240
trans_id = tt.trans_id_tree_path(paths[1])
3241
tt.delete_contents(trans_id)
3242
tt.create_hardlink(source_tree.abspath(paths[0]), trans_id)
added
removed
breezy/transform.py
