1
# Copyright (C) 2006, 2007, 2008, 2009 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
19
from stat import S_ISREG, S_IEXEC
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
32
revision as _mod_revision,
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
36
ReusingTransform, NotVersionedError, CantMoveRoot,
37
ExistingLimbo, ImmortalLimbo, NoFinalPath,
39
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
40
from bzrlib.inventory import InventoryEntry
41
from bzrlib.osutils import (
51
from bzrlib.progress import DummyProgress, ProgressPhase
52
from bzrlib.symbol_versioning import (
56
from bzrlib.trace import mutter, warning
57
from bzrlib import tree
59
import bzrlib.urlutils as urlutils
62
ROOT_PARENT = "root-parent"
65
def unique_add(map, key, value):
67
raise DuplicateKey(key=key)
71
class _TransformResults(object):
72
def __init__(self, modified_paths, rename_count):
74
self.modified_paths = modified_paths
75
self.rename_count = rename_count
78
class TreeTransformBase(object):
79
"""The base class for TreeTransform and its kin."""
81
def __init__(self, tree, pb=DummyProgress(),
85
:param tree: The tree that will be transformed, but not necessarily
87
:param pb: A ProgressBar indicating how much progress is being made
88
:param case_sensitive: If True, the target of the transform is
89
case sensitive, not just case preserving.
94
# mapping of trans_id -> new basename
96
# mapping of trans_id -> new parent trans_id
98
# mapping of trans_id with new contents -> new file_kind
99
self._new_contents = {}
100
# Set of trans_ids whose contents will be removed
101
self._removed_contents = set()
102
# Mapping of trans_id -> new execute-bit value
103
self._new_executability = {}
104
# Mapping of trans_id -> new tree-reference value
105
self._new_reference_revision = {}
106
# Mapping of trans_id -> new file_id
108
# Mapping of old file-id -> trans_id
109
self._non_present_ids = {}
110
# Mapping of new file_id -> trans_id
112
# Set of trans_ids that will be removed
113
self._removed_id = set()
114
# Mapping of path in old tree -> trans_id
115
self._tree_path_ids = {}
116
# Mapping trans_id -> path in old tree
117
self._tree_id_paths = {}
118
# The trans_id that will be used as the tree root
119
root_id = tree.get_root_id()
120
if root_id is not None:
121
self._new_root = self.trans_id_tree_file_id(root_id)
123
self._new_root = None
124
# Indictor of whether the transform has been applied
128
# Whether the target is case sensitive
129
self._case_sensitive_target = case_sensitive
130
# A counter of how many files have been renamed
131
self.rename_count = 0
134
"""Release the working tree lock, if held.
136
This is required if apply has not been invoked, but can be invoked
139
if self._tree is None:
144
def __get_root(self):
145
return self._new_root
147
root = property(__get_root)
149
def _assign_id(self):
150
"""Produce a new tranform id"""
151
new_id = "new-%s" % self._id_number
155
def create_path(self, name, parent):
156
"""Assign a transaction id to a new path"""
157
trans_id = self._assign_id()
158
unique_add(self._new_name, trans_id, name)
159
unique_add(self._new_parent, trans_id, parent)
162
def adjust_path(self, name, parent, trans_id):
163
"""Change the path that is assigned to a transaction id."""
164
if trans_id == self._new_root:
166
self._new_name[trans_id] = name
167
self._new_parent[trans_id] = parent
168
if parent == ROOT_PARENT:
169
if self._new_root is not None:
170
raise ValueError("Cannot have multiple roots.")
171
self._new_root = trans_id
173
def adjust_root_path(self, name, parent):
174
"""Emulate moving the root by moving all children, instead.
176
We do this by undoing the association of root's transaction id with the
177
current tree. This allows us to create a new directory with that
178
transaction id. We unversion the root directory and version the
179
physically new directory, and hope someone versions the tree root
182
old_root = self._new_root
183
old_root_file_id = self.final_file_id(old_root)
184
# force moving all children of root
185
for child_id in self.iter_tree_children(old_root):
186
if child_id != parent:
187
self.adjust_path(self.final_name(child_id),
188
self.final_parent(child_id), child_id)
189
file_id = self.final_file_id(child_id)
190
if file_id is not None:
191
self.unversion_file(child_id)
192
self.version_file(file_id, child_id)
194
# the physical root needs a new transaction id
195
self._tree_path_ids.pop("")
196
self._tree_id_paths.pop(old_root)
197
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
198
if parent == old_root:
199
parent = self._new_root
200
self.adjust_path(name, parent, old_root)
201
self.create_directory(old_root)
202
self.version_file(old_root_file_id, old_root)
203
self.unversion_file(self._new_root)
205
def trans_id_tree_file_id(self, inventory_id):
206
"""Determine the transaction id of a working tree file.
208
This reflects only files that already exist, not ones that will be
209
added by transactions.
211
if inventory_id is None:
212
raise ValueError('None is not a valid file id')
213
path = self._tree.id2path(inventory_id)
214
return self.trans_id_tree_path(path)
216
def trans_id_file_id(self, file_id):
217
"""Determine or set the transaction id associated with a file ID.
218
A new id is only created for file_ids that were never present. If
219
a transaction has been unversioned, it is deliberately still returned.
220
(this will likely lead to an unversioned parent conflict.)
223
raise ValueError('None is not a valid file id')
224
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
225
return self._r_new_id[file_id]
228
self._tree.iter_entries_by_dir([file_id]).next()
229
except StopIteration:
230
if file_id in self._non_present_ids:
231
return self._non_present_ids[file_id]
233
trans_id = self._assign_id()
234
self._non_present_ids[file_id] = trans_id
237
return self.trans_id_tree_file_id(file_id)
239
def trans_id_tree_path(self, path):
240
"""Determine (and maybe set) the transaction ID for a tree path."""
241
path = self.canonical_path(path)
242
if path not in self._tree_path_ids:
243
self._tree_path_ids[path] = self._assign_id()
244
self._tree_id_paths[self._tree_path_ids[path]] = path
245
return self._tree_path_ids[path]
247
def get_tree_parent(self, trans_id):
248
"""Determine id of the parent in the tree."""
249
path = self._tree_id_paths[trans_id]
252
return self.trans_id_tree_path(os.path.dirname(path))
254
def delete_contents(self, trans_id):
255
"""Schedule the contents of a path entry for deletion"""
256
self.tree_kind(trans_id)
257
self._removed_contents.add(trans_id)
259
def cancel_deletion(self, trans_id):
260
"""Cancel a scheduled deletion"""
261
self._removed_contents.remove(trans_id)
263
def unversion_file(self, trans_id):
264
"""Schedule a path entry to become unversioned"""
265
self._removed_id.add(trans_id)
267
def delete_versioned(self, trans_id):
268
"""Delete and unversion a versioned file"""
269
self.delete_contents(trans_id)
270
self.unversion_file(trans_id)
272
def set_executability(self, executability, trans_id):
273
"""Schedule setting of the 'execute' bit
274
To unschedule, set to None
276
if executability is None:
277
del self._new_executability[trans_id]
279
unique_add(self._new_executability, trans_id, executability)
281
def set_tree_reference(self, revision_id, trans_id):
282
"""Set the reference associated with a directory"""
283
unique_add(self._new_reference_revision, trans_id, revision_id)
285
def version_file(self, file_id, trans_id):
286
"""Schedule a file to become versioned."""
289
unique_add(self._new_id, trans_id, file_id)
290
unique_add(self._r_new_id, file_id, trans_id)
292
def cancel_versioning(self, trans_id):
293
"""Undo a previous versioning of a file"""
294
file_id = self._new_id[trans_id]
295
del self._new_id[trans_id]
296
del self._r_new_id[file_id]
298
def new_paths(self, filesystem_only=False):
299
"""Determine the paths of all new and changed files.
301
:param filesystem_only: if True, only calculate values for files
302
that require renames or execute bit changes.
306
stale_ids = self._needs_rename.difference(self._new_name)
307
stale_ids.difference_update(self._new_parent)
308
stale_ids.difference_update(self._new_contents)
309
stale_ids.difference_update(self._new_id)
310
needs_rename = self._needs_rename.difference(stale_ids)
311
id_sets = (needs_rename, self._new_executability)
313
id_sets = (self._new_name, self._new_parent, self._new_contents,
314
self._new_id, self._new_executability)
315
for id_set in id_sets:
316
new_ids.update(id_set)
317
return sorted(FinalPaths(self).get_paths(new_ids))
319
def _inventory_altered(self):
320
"""Get the trans_ids and paths of files needing new inv entries."""
322
for id_set in [self._new_name, self._new_parent, self._new_id,
323
self._new_executability]:
324
new_ids.update(id_set)
325
changed_kind = set(self._removed_contents)
326
changed_kind.intersection_update(self._new_contents)
327
changed_kind.difference_update(new_ids)
328
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
330
new_ids.update(changed_kind)
331
return sorted(FinalPaths(self).get_paths(new_ids))
333
def final_kind(self, trans_id):
334
"""Determine the final file kind, after any changes applied.
336
Raises NoSuchFile if the file does not exist/has no contents.
337
(It is conceivable that a path would be created without the
338
corresponding contents insertion command)
340
if trans_id in self._new_contents:
341
return self._new_contents[trans_id]
342
elif trans_id in self._removed_contents:
343
raise NoSuchFile(None)
345
return self.tree_kind(trans_id)
347
def tree_file_id(self, trans_id):
348
"""Determine the file id associated with the trans_id in the tree"""
350
path = self._tree_id_paths[trans_id]
352
# the file is a new, unversioned file, or invalid trans_id
354
# the file is old; the old id is still valid
355
if self._new_root == trans_id:
356
return self._tree.get_root_id()
357
return self._tree.path2id(path)
359
def final_file_id(self, trans_id):
360
"""Determine the file id after any changes are applied, or None.
362
None indicates that the file will not be versioned after changes are
366
return self._new_id[trans_id]
368
if trans_id in self._removed_id:
370
return self.tree_file_id(trans_id)
372
def inactive_file_id(self, trans_id):
373
"""Return the inactive file_id associated with a transaction id.
374
That is, the one in the tree or in non_present_ids.
375
The file_id may actually be active, too.
377
file_id = self.tree_file_id(trans_id)
378
if file_id is not None:
380
for key, value in self._non_present_ids.iteritems():
381
if value == trans_id:
384
def final_parent(self, trans_id):
385
"""Determine the parent file_id, after any changes are applied.
387
ROOT_PARENT is returned for the tree root.
390
return self._new_parent[trans_id]
392
return self.get_tree_parent(trans_id)
394
def final_name(self, trans_id):
395
"""Determine the final filename, after all changes are applied."""
397
return self._new_name[trans_id]
400
return os.path.basename(self._tree_id_paths[trans_id])
402
raise NoFinalPath(trans_id, self)
405
"""Return a map of parent: children for known parents.
407
Only new paths and parents of tree files with assigned ids are used.
410
items = list(self._new_parent.iteritems())
411
items.extend((t, self.final_parent(t)) for t in
412
self._tree_id_paths.keys())
413
for trans_id, parent_id in items:
414
if parent_id not in by_parent:
415
by_parent[parent_id] = set()
416
by_parent[parent_id].add(trans_id)
419
def path_changed(self, trans_id):
420
"""Return True if a trans_id's path has changed."""
421
return (trans_id in self._new_name) or (trans_id in self._new_parent)
423
def new_contents(self, trans_id):
424
return (trans_id in self._new_contents)
426
def find_conflicts(self):
427
"""Find any violations of inventory or filesystem invariants"""
428
if self._done is True:
429
raise ReusingTransform()
431
# ensure all children of all existent parents are known
432
# all children of non-existent parents are known, by definition.
433
self._add_tree_children()
434
by_parent = self.by_parent()
435
conflicts.extend(self._unversioned_parents(by_parent))
436
conflicts.extend(self._parent_loops())
437
conflicts.extend(self._duplicate_entries(by_parent))
438
conflicts.extend(self._duplicate_ids())
439
conflicts.extend(self._parent_type_conflicts(by_parent))
440
conflicts.extend(self._improper_versioning())
441
conflicts.extend(self._executability_conflicts())
442
conflicts.extend(self._overwrite_conflicts())
445
def _add_tree_children(self):
446
"""Add all the children of all active parents to the known paths.
448
Active parents are those which gain children, and those which are
449
removed. This is a necessary first step in detecting conflicts.
451
parents = self.by_parent().keys()
452
parents.extend([t for t in self._removed_contents if
453
self.tree_kind(t) == 'directory'])
454
for trans_id in self._removed_id:
455
file_id = self.tree_file_id(trans_id)
456
if file_id is not None:
457
if self._tree.inventory[file_id].kind == 'directory':
458
parents.append(trans_id)
459
elif self.tree_kind(trans_id) == 'directory':
460
parents.append(trans_id)
462
for parent_id in parents:
463
# ensure that all children are registered with the transaction
464
list(self.iter_tree_children(parent_id))
466
def has_named_child(self, by_parent, parent_id, name):
468
children = by_parent[parent_id]
471
for child in children:
472
if self.final_name(child) == name:
475
path = self._tree_id_paths[parent_id]
478
childpath = joinpath(path, name)
479
child_id = self._tree_path_ids.get(childpath)
481
return lexists(self._tree.abspath(childpath))
483
if self.final_parent(child_id) != parent_id:
485
if child_id in self._removed_contents:
486
# XXX What about dangling file-ids?
491
def _parent_loops(self):
492
"""No entry should be its own ancestor"""
494
for trans_id in self._new_parent:
497
while parent_id is not ROOT_PARENT:
500
parent_id = self.final_parent(parent_id)
503
if parent_id == trans_id:
504
conflicts.append(('parent loop', trans_id))
505
if parent_id in seen:
509
def _unversioned_parents(self, by_parent):
510
"""If parent directories are versioned, children must be versioned."""
512
for parent_id, children in by_parent.iteritems():
513
if parent_id is ROOT_PARENT:
515
if self.final_file_id(parent_id) is not None:
517
for child_id in children:
518
if self.final_file_id(child_id) is not None:
519
conflicts.append(('unversioned parent', parent_id))
523
def _improper_versioning(self):
524
"""Cannot version a file with no contents, or a bad type.
526
However, existing entries with no contents are okay.
529
for trans_id in self._new_id.iterkeys():
531
kind = self.final_kind(trans_id)
533
conflicts.append(('versioning no contents', trans_id))
535
if not InventoryEntry.versionable_kind(kind):
536
conflicts.append(('versioning bad kind', trans_id, kind))
539
def _executability_conflicts(self):
540
"""Check for bad executability changes.
542
Only versioned files may have their executability set, because
543
1. only versioned entries can have executability under windows
544
2. only files can be executable. (The execute bit on a directory
545
does not indicate searchability)
548
for trans_id in self._new_executability:
549
if self.final_file_id(trans_id) is None:
550
conflicts.append(('unversioned executability', trans_id))
553
non_file = self.final_kind(trans_id) != "file"
557
conflicts.append(('non-file executability', trans_id))
560
def _overwrite_conflicts(self):
561
"""Check for overwrites (not permitted on Win32)"""
563
for trans_id in self._new_contents:
565
self.tree_kind(trans_id)
568
if trans_id not in self._removed_contents:
569
conflicts.append(('overwrite', trans_id,
570
self.final_name(trans_id)))
573
def _duplicate_entries(self, by_parent):
574
"""No directory may have two entries with the same name."""
576
if (self._new_name, self._new_parent) == ({}, {}):
578
for children in by_parent.itervalues():
579
name_ids = [(self.final_name(t), t) for t in children]
580
if not self._case_sensitive_target:
581
name_ids = [(n.lower(), t) for n, t in name_ids]
585
for name, trans_id in name_ids:
587
kind = self.final_kind(trans_id)
590
file_id = self.final_file_id(trans_id)
591
if kind is None and file_id is None:
593
if name == last_name:
594
conflicts.append(('duplicate', last_trans_id, trans_id,
597
last_trans_id = trans_id
600
def _duplicate_ids(self):
601
"""Each inventory id may only be used once"""
603
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
605
all_ids = self._tree.all_file_ids()
606
active_tree_ids = all_ids.difference(removed_tree_ids)
607
for trans_id, file_id in self._new_id.iteritems():
608
if file_id in active_tree_ids:
609
old_trans_id = self.trans_id_tree_file_id(file_id)
610
conflicts.append(('duplicate id', old_trans_id, trans_id))
613
def _parent_type_conflicts(self, by_parent):
614
"""parents must have directory 'contents'."""
616
for parent_id, children in by_parent.iteritems():
617
if parent_id is ROOT_PARENT:
619
if not self._any_contents(children):
621
for child in children:
623
self.final_kind(child)
627
kind = self.final_kind(parent_id)
631
conflicts.append(('missing parent', parent_id))
632
elif kind != "directory":
633
conflicts.append(('non-directory parent', parent_id))
636
def _any_contents(self, trans_ids):
637
"""Return true if any of the trans_ids, will have contents."""
638
for trans_id in trans_ids:
640
kind = self.final_kind(trans_id)
646
def _set_executability(self, path, trans_id):
647
"""Set the executability of versioned files """
648
if supports_executable():
649
new_executability = self._new_executability[trans_id]
650
abspath = self._tree.abspath(path)
651
current_mode = os.stat(abspath).st_mode
652
if new_executability:
655
to_mode = current_mode | (0100 & ~umask)
656
# Enable x-bit for others only if they can read it.
657
if current_mode & 0004:
658
to_mode |= 0001 & ~umask
659
if current_mode & 0040:
660
to_mode |= 0010 & ~umask
662
to_mode = current_mode & ~0111
663
os.chmod(abspath, to_mode)
665
def _new_entry(self, name, parent_id, file_id):
666
"""Helper function to create a new filesystem entry."""
667
trans_id = self.create_path(name, parent_id)
668
if file_id is not None:
669
self.version_file(file_id, trans_id)
672
def new_file(self, name, parent_id, contents, file_id=None,
674
"""Convenience method to create files.
676
name is the name of the file to create.
677
parent_id is the transaction id of the parent directory of the file.
678
contents is an iterator of bytestrings, which will be used to produce
680
:param file_id: The inventory ID of the file, if it is to be versioned.
681
:param executable: Only valid when a file_id has been supplied.
683
trans_id = self._new_entry(name, parent_id, file_id)
684
# TODO: rather than scheduling a set_executable call,
685
# have create_file create the file with the right mode.
686
self.create_file(contents, trans_id)
687
if executable is not None:
688
self.set_executability(executable, trans_id)
691
def new_directory(self, name, parent_id, file_id=None):
692
"""Convenience method to create directories.
694
name is the name of the directory to create.
695
parent_id is the transaction id of the parent directory of the
697
file_id is the inventory ID of the directory, if it is to be versioned.
699
trans_id = self._new_entry(name, parent_id, file_id)
700
self.create_directory(trans_id)
703
def new_symlink(self, name, parent_id, target, file_id=None):
704
"""Convenience method to create symbolic link.
706
name is the name of the symlink to create.
707
parent_id is the transaction id of the parent directory of the symlink.
708
target is a bytestring of the target of the symlink.
709
file_id is the inventory ID of the file, if it is to be versioned.
711
trans_id = self._new_entry(name, parent_id, file_id)
712
self.create_symlink(target, trans_id)
715
def _affected_ids(self):
716
"""Return the set of transform ids affected by the transform"""
717
trans_ids = set(self._removed_id)
718
trans_ids.update(self._new_id.keys())
719
trans_ids.update(self._removed_contents)
720
trans_ids.update(self._new_contents.keys())
721
trans_ids.update(self._new_executability.keys())
722
trans_ids.update(self._new_name.keys())
723
trans_ids.update(self._new_parent.keys())
726
def _get_file_id_maps(self):
727
"""Return mapping of file_ids to trans_ids in the to and from states"""
728
trans_ids = self._affected_ids()
731
# Build up two dicts: trans_ids associated with file ids in the
732
# FROM state, vs the TO state.
733
for trans_id in trans_ids:
734
from_file_id = self.tree_file_id(trans_id)
735
if from_file_id is not None:
736
from_trans_ids[from_file_id] = trans_id
737
to_file_id = self.final_file_id(trans_id)
738
if to_file_id is not None:
739
to_trans_ids[to_file_id] = trans_id
740
return from_trans_ids, to_trans_ids
742
def _from_file_data(self, from_trans_id, from_versioned, file_id):
743
"""Get data about a file in the from (tree) state
745
Return a (name, parent, kind, executable) tuple
747
from_path = self._tree_id_paths.get(from_trans_id)
749
# get data from working tree if versioned
750
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
751
from_name = from_entry.name
752
from_parent = from_entry.parent_id
755
if from_path is None:
756
# File does not exist in FROM state
760
# File exists, but is not versioned. Have to use path-
762
from_name = os.path.basename(from_path)
763
tree_parent = self.get_tree_parent(from_trans_id)
764
from_parent = self.tree_file_id(tree_parent)
765
if from_path is not None:
766
from_kind, from_executable, from_stats = \
767
self._tree._comparison_data(from_entry, from_path)
770
from_executable = False
771
return from_name, from_parent, from_kind, from_executable
773
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
774
"""Get data about a file in the to (target) state
776
Return a (name, parent, kind, executable) tuple
778
to_name = self.final_name(to_trans_id)
780
to_kind = self.final_kind(to_trans_id)
783
to_parent = self.final_file_id(self.final_parent(to_trans_id))
784
if to_trans_id in self._new_executability:
785
to_executable = self._new_executability[to_trans_id]
786
elif to_trans_id == from_trans_id:
787
to_executable = from_executable
789
to_executable = False
790
return to_name, to_parent, to_kind, to_executable
792
def iter_changes(self):
793
"""Produce output in the same format as Tree.iter_changes.
795
Will produce nonsensical results if invoked while inventory/filesystem
796
conflicts (as reported by TreeTransform.find_conflicts()) are present.
798
This reads the Transform, but only reproduces changes involving a
799
file_id. Files that are not versioned in either of the FROM or TO
800
states are not reflected.
802
final_paths = FinalPaths(self)
803
from_trans_ids, to_trans_ids = self._get_file_id_maps()
805
# Now iterate through all active file_ids
806
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
808
from_trans_id = from_trans_ids.get(file_id)
809
# find file ids, and determine versioning state
810
if from_trans_id is None:
811
from_versioned = False
812
from_trans_id = to_trans_ids[file_id]
814
from_versioned = True
815
to_trans_id = to_trans_ids.get(file_id)
816
if to_trans_id is None:
818
to_trans_id = from_trans_id
822
from_name, from_parent, from_kind, from_executable = \
823
self._from_file_data(from_trans_id, from_versioned, file_id)
825
to_name, to_parent, to_kind, to_executable = \
826
self._to_file_data(to_trans_id, from_trans_id, from_executable)
828
if not from_versioned:
831
from_path = self._tree_id_paths.get(from_trans_id)
835
to_path = final_paths.get_path(to_trans_id)
836
if from_kind != to_kind:
838
elif to_kind in ('file', 'symlink') and (
839
to_trans_id != from_trans_id or
840
to_trans_id in self._new_contents):
842
if (not modified and from_versioned == to_versioned and
843
from_parent==to_parent and from_name == to_name and
844
from_executable == to_executable):
846
results.append((file_id, (from_path, to_path), modified,
847
(from_versioned, to_versioned),
848
(from_parent, to_parent),
849
(from_name, to_name),
850
(from_kind, to_kind),
851
(from_executable, to_executable)))
852
return iter(sorted(results, key=lambda x:x[1]))
854
def get_preview_tree(self):
855
"""Return a tree representing the result of the transform.
857
This tree only supports the subset of Tree functionality required
858
by show_diff_trees. It must only be compared to tt._tree.
860
return _PreviewTree(self)
862
def _text_parent(self, trans_id):
863
file_id = self.tree_file_id(trans_id)
865
if file_id is None or self._tree.kind(file_id) != 'file':
867
except errors.NoSuchFile:
871
def _get_parents_texts(self, trans_id):
872
"""Get texts for compression parents of this file."""
873
file_id = self._text_parent(trans_id)
876
return (self._tree.get_file_text(file_id),)
878
def _get_parents_lines(self, trans_id):
879
"""Get lines for compression parents of this file."""
880
file_id = self._text_parent(trans_id)
883
return (self._tree.get_file_lines(file_id),)
885
def serialize(self, serializer):
886
"""Serialize this TreeTransform.
888
:param serializer: A Serialiser like pack.ContainerSerializer.
890
new_name = dict((k, v.encode('utf-8')) for k, v in
891
self._new_name.items())
892
new_executability = dict((k, int(v)) for k, v in
893
self._new_executability.items())
894
tree_path_ids = dict((k.encode('utf-8'), v)
895
for k, v in self._tree_path_ids.items())
897
'_id_number': self._id_number,
898
'_new_name': new_name,
899
'_new_parent': self._new_parent,
900
'_new_executability': new_executability,
901
'_new_id': self._new_id,
902
'_tree_path_ids': tree_path_ids,
903
'_removed_id': list(self._removed_id),
904
'_removed_contents': list(self._removed_contents),
905
'_non_present_ids': self._non_present_ids,
907
yield serializer.bytes_record(bencode.bencode(attribs),
909
for trans_id, kind in self._new_contents.items():
911
lines = osutils.chunks_to_lines(
912
self._read_file_chunks(trans_id))
913
parents = self._get_parents_lines(trans_id)
914
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
915
content = ''.join(mpdiff.to_patch())
916
if kind == 'directory':
918
if kind == 'symlink':
919
content = self._read_symlink_target(trans_id)
920
yield serializer.bytes_record(content, ((trans_id, kind),))
922
def deserialize(self, records):
923
"""Deserialize a stored TreeTransform.
925
:param records: An iterable of (names, content) tuples, as per
926
pack.ContainerPushParser.
928
names, content = records.next()
929
attribs = bencode.bdecode(content)
930
self._id_number = attribs['_id_number']
931
self._new_name = dict((k, v.decode('utf-8'))
932
for k, v in attribs['_new_name'].items())
933
self._new_parent = attribs['_new_parent']
934
self._new_executability = dict((k, bool(v)) for k, v in
935
attribs['_new_executability'].items())
936
self._new_id = attribs['_new_id']
937
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
938
self._tree_path_ids = {}
939
self._tree_id_paths = {}
940
for bytepath, trans_id in attribs['_tree_path_ids'].items():
941
path = bytepath.decode('utf-8')
942
self._tree_path_ids[path] = trans_id
943
self._tree_id_paths[trans_id] = path
944
self._removed_id = set(attribs['_removed_id'])
945
self._removed_contents = set(attribs['_removed_contents'])
946
self._non_present_ids = attribs['_non_present_ids']
947
for ((trans_id, kind),), content in records:
949
mpdiff = multiparent.MultiParent.from_patch(content)
950
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
951
self.create_file(lines, trans_id)
952
if kind == 'directory':
953
self.create_directory(trans_id)
954
if kind == 'symlink':
955
self.create_symlink(content.decode('utf-8'), trans_id)
958
class DiskTreeTransform(TreeTransformBase):
959
"""Tree transform storing its contents on disk."""
961
def __init__(self, tree, limbodir, pb=DummyProgress(),
962
case_sensitive=True):
964
:param tree: The tree that will be transformed, but not necessarily
966
:param limbodir: A directory where new files can be stored until
967
they are installed in their proper places
968
:param pb: A ProgressBar indicating how much progress is being made
969
:param case_sensitive: If True, the target of the transform is
970
case sensitive, not just case preserving.
972
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
973
self._limbodir = limbodir
974
self._deletiondir = None
975
# A mapping of transform ids to their limbo filename
976
self._limbo_files = {}
977
# A mapping of transform ids to a set of the transform ids of children
978
# that their limbo directory has
979
self._limbo_children = {}
980
# Map transform ids to maps of child filename to child transform id
981
self._limbo_children_names = {}
982
# List of transform ids that need to be renamed from limbo into place
983
self._needs_rename = set()
986
"""Release the working tree lock, if held, clean up limbo dir.
988
This is required if apply has not been invoked, but can be invoked
991
if self._tree is None:
994
entries = [(self._limbo_name(t), t, k) for t, k in
995
self._new_contents.iteritems()]
996
entries.sort(reverse=True)
997
for path, trans_id, kind in entries:
1000
delete_any(self._limbodir)
1002
# We don't especially care *why* the dir is immortal.
1003
raise ImmortalLimbo(self._limbodir)
1005
if self._deletiondir is not None:
1006
delete_any(self._deletiondir)
1008
raise errors.ImmortalPendingDeletion(self._deletiondir)
1010
TreeTransformBase.finalize(self)
1012
def _limbo_name(self, trans_id):
1013
"""Generate the limbo name of a file"""
1014
limbo_name = self._limbo_files.get(trans_id)
1015
if limbo_name is not None:
1017
parent = self._new_parent.get(trans_id)
1018
# if the parent directory is already in limbo (e.g. when building a
1019
# tree), choose a limbo name inside the parent, to reduce further
1021
use_direct_path = False
1022
if self._new_contents.get(parent) == 'directory':
1023
filename = self._new_name.get(trans_id)
1024
if filename is not None:
1025
if parent not in self._limbo_children:
1026
self._limbo_children[parent] = set()
1027
self._limbo_children_names[parent] = {}
1028
use_direct_path = True
1029
# the direct path can only be used if no other file has
1030
# already taken this pathname, i.e. if the name is unused, or
1031
# if it is already associated with this trans_id.
1032
elif self._case_sensitive_target:
1033
if (self._limbo_children_names[parent].get(filename)
1034
in (trans_id, None)):
1035
use_direct_path = True
1037
for l_filename, l_trans_id in\
1038
self._limbo_children_names[parent].iteritems():
1039
if l_trans_id == trans_id:
1041
if l_filename.lower() == filename.lower():
1044
use_direct_path = True
1047
limbo_name = pathjoin(self._limbo_files[parent], filename)
1048
self._limbo_children[parent].add(trans_id)
1049
self._limbo_children_names[parent][filename] = trans_id
1051
limbo_name = pathjoin(self._limbodir, trans_id)
1052
self._needs_rename.add(trans_id)
1053
self._limbo_files[trans_id] = limbo_name
1056
def adjust_path(self, name, parent, trans_id):
1057
previous_parent = self._new_parent.get(trans_id)
1058
previous_name = self._new_name.get(trans_id)
1059
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1060
if (trans_id in self._limbo_files and
1061
trans_id not in self._needs_rename):
1062
self._rename_in_limbo([trans_id])
1063
self._limbo_children[previous_parent].remove(trans_id)
1064
del self._limbo_children_names[previous_parent][previous_name]
1066
def _rename_in_limbo(self, trans_ids):
1067
"""Fix limbo names so that the right final path is produced.
1069
This means we outsmarted ourselves-- we tried to avoid renaming
1070
these files later by creating them with their final names in their
1071
final parents. But now the previous name or parent is no longer
1072
suitable, so we have to rename them.
1074
Even for trans_ids that have no new contents, we must remove their
1075
entries from _limbo_files, because they are now stale.
1077
for trans_id in trans_ids:
1078
old_path = self._limbo_files.pop(trans_id)
1079
if trans_id not in self._new_contents:
1081
new_path = self._limbo_name(trans_id)
1082
os.rename(old_path, new_path)
1084
def create_file(self, contents, trans_id, mode_id=None):
1085
"""Schedule creation of a new file.
1089
Contents is an iterator of strings, all of which will be written
1090
to the target destination.
1092
New file takes the permissions of any existing file with that id,
1093
unless mode_id is specified.
1095
name = self._limbo_name(trans_id)
1096
f = open(name, 'wb')
1099
unique_add(self._new_contents, trans_id, 'file')
1101
# Clean up the file, it never got registered so
1102
# TreeTransform.finalize() won't clean it up.
1107
f.writelines(contents)
1110
self._set_mode(trans_id, mode_id, S_ISREG)
1112
def _read_file_chunks(self, trans_id):
1113
cur_file = open(self._limbo_name(trans_id), 'rb')
1115
return cur_file.readlines()
1119
def _read_symlink_target(self, trans_id):
1120
return os.readlink(self._limbo_name(trans_id))
1122
def create_hardlink(self, path, trans_id):
1123
"""Schedule creation of a hard link"""
1124
name = self._limbo_name(trans_id)
1128
if e.errno != errno.EPERM:
1130
raise errors.HardLinkNotSupported(path)
1132
unique_add(self._new_contents, trans_id, 'file')
1134
# Clean up the file, it never got registered so
1135
# TreeTransform.finalize() won't clean it up.
1139
def create_directory(self, trans_id):
1140
"""Schedule creation of a new directory.
1142
See also new_directory.
1144
os.mkdir(self._limbo_name(trans_id))
1145
unique_add(self._new_contents, trans_id, 'directory')
1147
def create_symlink(self, target, trans_id):
1148
"""Schedule creation of a new symbolic link.
1150
target is a bytestring.
1151
See also new_symlink.
1154
os.symlink(target, self._limbo_name(trans_id))
1155
unique_add(self._new_contents, trans_id, 'symlink')
1158
path = FinalPaths(self).get_path(trans_id)
1161
raise UnableCreateSymlink(path=path)
1163
def cancel_creation(self, trans_id):
1164
"""Cancel the creation of new file contents."""
1165
del self._new_contents[trans_id]
1166
children = self._limbo_children.get(trans_id)
1167
# if this is a limbo directory with children, move them before removing
1169
if children is not None:
1170
self._rename_in_limbo(children)
1171
del self._limbo_children[trans_id]
1172
del self._limbo_children_names[trans_id]
1173
delete_any(self._limbo_name(trans_id))
1176
class TreeTransform(DiskTreeTransform):
1177
"""Represent a tree transformation.
1179
This object is designed to support incremental generation of the transform,
1182
However, it gives optimum performance when parent directories are created
1183
before their contents. The transform is then able to put child files
1184
directly in their parent directory, avoiding later renames.
1186
It is easy to produce malformed transforms, but they are generally
1187
harmless. Attempting to apply a malformed transform will cause an
1188
exception to be raised before any modifications are made to the tree.
1190
Many kinds of malformed transforms can be corrected with the
1191
resolve_conflicts function. The remaining ones indicate programming error,
1192
such as trying to create a file with no path.
1194
Two sets of file creation methods are supplied. Convenience methods are:
1199
These are composed of the low-level methods:
1201
* create_file or create_directory or create_symlink
1205
Transform/Transaction ids
1206
-------------------------
1207
trans_ids are temporary ids assigned to all files involved in a transform.
1208
It's possible, even common, that not all files in the Tree have trans_ids.
1210
trans_ids are used because filenames and file_ids are not good enough
1211
identifiers; filenames change, and not all files have file_ids. File-ids
1212
are also associated with trans-ids, so that moving a file moves its
1215
trans_ids are only valid for the TreeTransform that generated them.
1219
Limbo is a temporary directory use to hold new versions of files.
1220
Files are added to limbo by create_file, create_directory, create_symlink,
1221
and their convenience variants (new_*). Files may be removed from limbo
1222
using cancel_creation. Files are renamed from limbo into their final
1223
location as part of TreeTransform.apply
1225
Limbo must be cleaned up, by either calling TreeTransform.apply or
1226
calling TreeTransform.finalize.
1228
Files are placed into limbo inside their parent directories, where
1229
possible. This reduces subsequent renames, and makes operations involving
1230
lots of files faster. This optimization is only possible if the parent
1231
directory is created *before* creating any of its children, so avoid
1232
creating children before parents, where possible.
1236
This temporary directory is used by _FileMover for storing files that are
1237
about to be deleted. In case of rollback, the files will be restored.
1238
FileMover does not delete files until it is sure that a rollback will not
1241
def __init__(self, tree, pb=DummyProgress()):
1242
"""Note: a tree_write lock is taken on the tree.
1244
Use TreeTransform.finalize() to release the lock (can be omitted if
1245
TreeTransform.apply() called).
1247
tree.lock_tree_write()
1250
limbodir = urlutils.local_path_from_url(
1251
tree._transport.abspath('limbo'))
1255
if e.errno == errno.EEXIST:
1256
raise ExistingLimbo(limbodir)
1257
deletiondir = urlutils.local_path_from_url(
1258
tree._transport.abspath('pending-deletion'))
1260
os.mkdir(deletiondir)
1262
if e.errno == errno.EEXIST:
1263
raise errors.ExistingPendingDeletion(deletiondir)
1268
# Cache of realpath results, to speed up canonical_path
1269
self._realpaths = {}
1270
# Cache of relpath results, to speed up canonical_path
1272
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1273
tree.case_sensitive)
1274
self._deletiondir = deletiondir
1276
def canonical_path(self, path):
1277
"""Get the canonical tree-relative path"""
1278
# don't follow final symlinks
1279
abs = self._tree.abspath(path)
1280
if abs in self._relpaths:
1281
return self._relpaths[abs]
1282
dirname, basename = os.path.split(abs)
1283
if dirname not in self._realpaths:
1284
self._realpaths[dirname] = os.path.realpath(dirname)
1285
dirname = self._realpaths[dirname]
1286
abs = pathjoin(dirname, basename)
1287
if dirname in self._relpaths:
1288
relpath = pathjoin(self._relpaths[dirname], basename)
1289
relpath = relpath.rstrip('/\\')
1291
relpath = self._tree.relpath(abs)
1292
self._relpaths[abs] = relpath
1295
def tree_kind(self, trans_id):
1296
"""Determine the file kind in the working tree.
1298
Raises NoSuchFile if the file does not exist
1300
path = self._tree_id_paths.get(trans_id)
1302
raise NoSuchFile(None)
1304
return file_kind(self._tree.abspath(path))
1306
if e.errno != errno.ENOENT:
1309
raise NoSuchFile(path)
1311
def _set_mode(self, trans_id, mode_id, typefunc):
1312
"""Set the mode of new file contents.
1313
The mode_id is the existing file to get the mode from (often the same
1314
as trans_id). The operation is only performed if there's a mode match
1315
according to typefunc.
1320
old_path = self._tree_id_paths[mode_id]
1324
mode = os.stat(self._tree.abspath(old_path)).st_mode
1326
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1327
# Either old_path doesn't exist, or the parent of the
1328
# target is not a directory (but will be one eventually)
1329
# Either way, we know it doesn't exist *right now*
1330
# See also bug #248448
1335
os.chmod(self._limbo_name(trans_id), mode)
1337
def iter_tree_children(self, parent_id):
1338
"""Iterate through the entry's tree children, if any"""
1340
path = self._tree_id_paths[parent_id]
1344
children = os.listdir(self._tree.abspath(path))
1346
if not (osutils._is_error_enotdir(e)
1347
or e.errno in (errno.ENOENT, errno.ESRCH)):
1351
for child in children:
1352
childpath = joinpath(path, child)
1353
if self._tree.is_control_filename(childpath):
1355
yield self.trans_id_tree_path(childpath)
1358
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1359
"""Apply all changes to the inventory and filesystem.
1361
If filesystem or inventory conflicts are present, MalformedTransform
1364
If apply succeeds, finalize is not necessary.
1366
:param no_conflicts: if True, the caller guarantees there are no
1367
conflicts, so no check is made.
1368
:param precomputed_delta: An inventory delta to use instead of
1370
:param _mover: Supply an alternate FileMover, for testing
1372
if not no_conflicts:
1373
conflicts = self.find_conflicts()
1374
if len(conflicts) != 0:
1375
raise MalformedTransform(conflicts=conflicts)
1376
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1378
if precomputed_delta is None:
1379
child_pb.update('Apply phase', 0, 2)
1380
inventory_delta = self._generate_inventory_delta()
1383
inventory_delta = precomputed_delta
1386
mover = _FileMover()
1390
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1391
self._apply_removals(mover)
1392
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1393
modified_paths = self._apply_insertions(mover)
1398
mover.apply_deletions()
1401
self._tree.apply_inventory_delta(inventory_delta)
1404
return _TransformResults(modified_paths, self.rename_count)
1406
def _generate_inventory_delta(self):
1407
"""Generate an inventory delta for the current transform."""
1408
inventory_delta = []
1409
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1410
new_paths = self._inventory_altered()
1411
total_entries = len(new_paths) + len(self._removed_id)
1413
for num, trans_id in enumerate(self._removed_id):
1415
child_pb.update('removing file', num, total_entries)
1416
if trans_id == self._new_root:
1417
file_id = self._tree.get_root_id()
1419
file_id = self.tree_file_id(trans_id)
1420
# File-id isn't really being deleted, just moved
1421
if file_id in self._r_new_id:
1423
path = self._tree_id_paths[trans_id]
1424
inventory_delta.append((path, None, file_id, None))
1425
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1427
entries = self._tree.iter_entries_by_dir(
1428
new_path_file_ids.values())
1429
old_paths = dict((e.file_id, p) for p, e in entries)
1431
for num, (path, trans_id) in enumerate(new_paths):
1433
child_pb.update('adding file',
1434
num + len(self._removed_id), total_entries)
1435
file_id = new_path_file_ids[trans_id]
1440
kind = self.final_kind(trans_id)
1442
kind = self._tree.stored_kind(file_id)
1443
parent_trans_id = self.final_parent(trans_id)
1444
parent_file_id = new_path_file_ids.get(parent_trans_id)
1445
if parent_file_id is None:
1446
parent_file_id = self.final_file_id(parent_trans_id)
1447
if trans_id in self._new_reference_revision:
1448
new_entry = inventory.TreeReference(
1450
self._new_name[trans_id],
1451
self.final_file_id(self._new_parent[trans_id]),
1452
None, self._new_reference_revision[trans_id])
1454
new_entry = inventory.make_entry(kind,
1455
self.final_name(trans_id),
1456
parent_file_id, file_id)
1457
old_path = old_paths.get(new_entry.file_id)
1458
new_executability = self._new_executability.get(trans_id)
1459
if new_executability is not None:
1460
new_entry.executable = new_executability
1461
inventory_delta.append(
1462
(old_path, path, new_entry.file_id, new_entry))
1465
return inventory_delta
1467
def _apply_removals(self, mover):
1468
"""Perform tree operations that remove directory/inventory names.
1470
That is, delete files that are to be deleted, and put any files that
1471
need renaming into limbo. This must be done in strict child-to-parent
1474
If inventory_delta is None, no inventory delta generation is performed.
1476
tree_paths = list(self._tree_path_ids.iteritems())
1477
tree_paths.sort(reverse=True)
1478
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1480
for num, data in enumerate(tree_paths):
1481
path, trans_id = data
1482
child_pb.update('removing file', num, len(tree_paths))
1483
full_path = self._tree.abspath(path)
1484
if trans_id in self._removed_contents:
1485
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1487
elif trans_id in self._new_name or trans_id in \
1490
mover.rename(full_path, self._limbo_name(trans_id))
1492
if e.errno != errno.ENOENT:
1495
self.rename_count += 1
1499
def _apply_insertions(self, mover):
1500
"""Perform tree operations that insert directory/inventory names.
1502
That is, create any files that need to be created, and restore from
1503
limbo any files that needed renaming. This must be done in strict
1504
parent-to-child order.
1506
If inventory_delta is None, no inventory delta is calculated, and
1507
no list of modified paths is returned.
1509
new_paths = self.new_paths(filesystem_only=True)
1511
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1513
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1515
for num, (path, trans_id) in enumerate(new_paths):
1517
child_pb.update('adding file', num, len(new_paths))
1518
full_path = self._tree.abspath(path)
1519
if trans_id in self._needs_rename:
1521
mover.rename(self._limbo_name(trans_id), full_path)
1523
# We may be renaming a dangling inventory id
1524
if e.errno != errno.ENOENT:
1527
self.rename_count += 1
1528
if (trans_id in self._new_contents or
1529
self.path_changed(trans_id)):
1530
if trans_id in self._new_contents:
1531
modified_paths.append(full_path)
1532
if trans_id in self._new_executability:
1533
self._set_executability(path, trans_id)
1536
self._new_contents.clear()
1537
return modified_paths
1540
class TransformPreview(DiskTreeTransform):
1541
"""A TreeTransform for generating preview trees.
1543
Unlike TreeTransform, this version works when the input tree is a
1544
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1545
unversioned files in the input tree.
1548
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1550
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1551
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1553
def canonical_path(self, path):
1556
def tree_kind(self, trans_id):
1557
path = self._tree_id_paths.get(trans_id)
1559
raise NoSuchFile(None)
1560
file_id = self._tree.path2id(path)
1561
return self._tree.kind(file_id)
1563
def _set_mode(self, trans_id, mode_id, typefunc):
1564
"""Set the mode of new file contents.
1565
The mode_id is the existing file to get the mode from (often the same
1566
as trans_id). The operation is only performed if there's a mode match
1567
according to typefunc.
1569
# is it ok to ignore this? probably
1572
def iter_tree_children(self, parent_id):
1573
"""Iterate through the entry's tree children, if any"""
1575
path = self._tree_id_paths[parent_id]
1578
file_id = self.tree_file_id(parent_id)
1581
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1582
children = getattr(entry, 'children', {})
1583
for child in children:
1584
childpath = joinpath(path, child)
1585
yield self.trans_id_tree_path(childpath)
1588
class _PreviewTree(tree.Tree):
1589
"""Partial implementation of Tree to support show_diff_trees"""
1591
def __init__(self, transform):
1592
self._transform = transform
1593
self._final_paths = FinalPaths(transform)
1594
self.__by_parent = None
1595
self._parent_ids = []
1596
self._all_children_cache = {}
1597
self._path2trans_id_cache = {}
1598
self._final_name_cache = {}
1600
def _changes(self, file_id):
1601
for changes in self._transform.iter_changes():
1602
if changes[0] == file_id:
1605
def _content_change(self, file_id):
1606
"""Return True if the content of this file changed"""
1607
changes = self._changes(file_id)
1608
# changes[2] is true if the file content changed. See
1609
# InterTree.iter_changes.
1610
return (changes is not None and changes[2])
1612
def _get_repository(self):
1613
repo = getattr(self._transform._tree, '_repository', None)
1615
repo = self._transform._tree.branch.repository
1618
def _iter_parent_trees(self):
1619
for revision_id in self.get_parent_ids():
1621
yield self.revision_tree(revision_id)
1622
except errors.NoSuchRevisionInTree:
1623
yield self._get_repository().revision_tree(revision_id)
1625
def _get_file_revision(self, file_id, vf, tree_revision):
1626
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1627
self._iter_parent_trees()]
1628
vf.add_lines((file_id, tree_revision), parent_keys,
1629
self.get_file(file_id).readlines())
1630
repo = self._get_repository()
1631
base_vf = repo.texts
1632
if base_vf not in vf.fallback_versionedfiles:
1633
vf.fallback_versionedfiles.append(base_vf)
1634
return tree_revision
1636
def _stat_limbo_file(self, file_id):
1637
trans_id = self._transform.trans_id_file_id(file_id)
1638
name = self._transform._limbo_name(trans_id)
1639
return os.lstat(name)
1642
def _by_parent(self):
1643
if self.__by_parent is None:
1644
self.__by_parent = self._transform.by_parent()
1645
return self.__by_parent
1647
def _comparison_data(self, entry, path):
1648
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1649
if kind == 'missing':
1653
file_id = self._transform.final_file_id(self._path2trans_id(path))
1654
executable = self.is_executable(file_id, path)
1655
return kind, executable, None
1657
def lock_read(self):
1658
# Perhaps in theory, this should lock the TreeTransform?
1665
def inventory(self):
1666
"""This Tree does not use inventory as its backing data."""
1667
raise NotImplementedError(_PreviewTree.inventory)
1669
def get_root_id(self):
1670
return self._transform.final_file_id(self._transform.root)
1672
def all_file_ids(self):
1673
tree_ids = set(self._transform._tree.all_file_ids())
1674
tree_ids.difference_update(self._transform.tree_file_id(t)
1675
for t in self._transform._removed_id)
1676
tree_ids.update(self._transform._new_id.values())
1680
return iter(self.all_file_ids())
1682
def has_id(self, file_id):
1683
if file_id in self._transform._r_new_id:
1685
elif file_id in set([self._transform.tree_file_id(trans_id) for
1686
trans_id in self._transform._removed_id]):
1689
return self._transform._tree.has_id(file_id)
1691
def _path2trans_id(self, path):
1692
# We must not use None here, because that is a valid value to store.
1693
trans_id = self._path2trans_id_cache.get(path, object)
1694
if trans_id is not object:
1696
segments = splitpath(path)
1697
cur_parent = self._transform.root
1698
for cur_segment in segments:
1699
for child in self._all_children(cur_parent):
1700
final_name = self._final_name_cache.get(child)
1701
if final_name is None:
1702
final_name = self._transform.final_name(child)
1703
self._final_name_cache[child] = final_name
1704
if final_name == cur_segment:
1708
self._path2trans_id_cache[path] = None
1710
self._path2trans_id_cache[path] = cur_parent
1713
def path2id(self, path):
1714
return self._transform.final_file_id(self._path2trans_id(path))
1716
def id2path(self, file_id):
1717
trans_id = self._transform.trans_id_file_id(file_id)
1719
return self._final_paths._determine_path(trans_id)
1721
raise errors.NoSuchId(self, file_id)
1723
def _all_children(self, trans_id):
1724
children = self._all_children_cache.get(trans_id)
1725
if children is not None:
1727
children = set(self._transform.iter_tree_children(trans_id))
1728
# children in the _new_parent set are provided by _by_parent.
1729
children.difference_update(self._transform._new_parent.keys())
1730
children.update(self._by_parent.get(trans_id, []))
1731
self._all_children_cache[trans_id] = children
1734
def iter_children(self, file_id):
1735
trans_id = self._transform.trans_id_file_id(file_id)
1736
for child_trans_id in self._all_children(trans_id):
1737
yield self._transform.final_file_id(child_trans_id)
1740
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1741
in self._transform._tree.extras())
1742
possible_extras.update(self._transform._new_contents)
1743
possible_extras.update(self._transform._removed_id)
1744
for trans_id in possible_extras:
1745
if self._transform.final_file_id(trans_id) is None:
1746
yield self._final_paths._determine_path(trans_id)
1748
def _make_inv_entries(self, ordered_entries, specific_file_ids=None):
1749
for trans_id, parent_file_id in ordered_entries:
1750
file_id = self._transform.final_file_id(trans_id)
1753
if (specific_file_ids is not None
1754
and file_id not in specific_file_ids):
1757
kind = self._transform.final_kind(trans_id)
1759
kind = self._transform._tree.stored_kind(file_id)
1760
new_entry = inventory.make_entry(
1762
self._transform.final_name(trans_id),
1763
parent_file_id, file_id)
1764
yield new_entry, trans_id
1766
def _list_files_by_dir(self):
1767
todo = [ROOT_PARENT]
1769
while len(todo) > 0:
1771
parent_file_id = self._transform.final_file_id(parent)
1772
children = list(self._all_children(parent))
1773
paths = dict(zip(children, self._final_paths.get_paths(children)))
1774
children.sort(key=paths.get)
1775
todo.extend(reversed(children))
1776
for trans_id in children:
1777
ordered_ids.append((trans_id, parent_file_id))
1780
def iter_entries_by_dir(self, specific_file_ids=None):
1781
# This may not be a maximally efficient implementation, but it is
1782
# reasonably straightforward. An implementation that grafts the
1783
# TreeTransform changes onto the tree's iter_entries_by_dir results
1784
# might be more efficient, but requires tricky inferences about stack
1786
ordered_ids = self._list_files_by_dir()
1787
for entry, trans_id in self._make_inv_entries(ordered_ids,
1789
yield unicode(self._final_paths.get_path(trans_id)), entry
1791
def _iter_entries_for_dir(self, dir_path):
1792
"""Return path, entry for items in a directory without recursing down."""
1793
dir_file_id = self.path2id(dir_path)
1795
for file_id in self.iter_children(dir_file_id):
1796
trans_id = self._transform.trans_id_file_id(file_id)
1797
ordered_ids.append((trans_id, file_id))
1798
for entry, trans_id in self._make_inv_entries(ordered_ids):
1799
yield unicode(self._final_paths.get_path(trans_id)), entry
1801
def list_files(self, include_root=False, from_dir=None, recursive=True):
1802
"""See WorkingTree.list_files."""
1803
# XXX This should behave like WorkingTree.list_files, but is really
1804
# more like RevisionTree.list_files.
1808
prefix = from_dir + '/'
1809
entries = self.iter_entries_by_dir()
1810
for path, entry in entries:
1811
if entry.name == '' and not include_root:
1814
if not path.startswith(prefix):
1816
path = path[len(prefix):]
1817
yield path, 'V', entry.kind, entry.file_id, entry
1819
if from_dir is None and include_root is True:
1820
root_entry = inventory.make_entry('directory', '',
1821
ROOT_PARENT, self.get_root_id())
1822
yield '', 'V', 'directory', root_entry.file_id, root_entry
1823
entries = self._iter_entries_for_dir(from_dir or '')
1824
for path, entry in entries:
1825
yield path, 'V', entry.kind, entry.file_id, entry
1827
def kind(self, file_id):
1828
trans_id = self._transform.trans_id_file_id(file_id)
1829
return self._transform.final_kind(trans_id)
1831
def stored_kind(self, file_id):
1832
trans_id = self._transform.trans_id_file_id(file_id)
1834
return self._transform._new_contents[trans_id]
1836
return self._transform._tree.stored_kind(file_id)
1838
def get_file_mtime(self, file_id, path=None):
1839
"""See Tree.get_file_mtime"""
1840
if not self._content_change(file_id):
1841
return self._transform._tree.get_file_mtime(file_id, path)
1842
return self._stat_limbo_file(file_id).st_mtime
1844
def _file_size(self, entry, stat_value):
1845
return self.get_file_size(entry.file_id)
1847
def get_file_size(self, file_id):
1848
"""See Tree.get_file_size"""
1849
if self.kind(file_id) == 'file':
1850
return self._transform._tree.get_file_size(file_id)
1854
def get_file_sha1(self, file_id, path=None, stat_value=None):
1855
trans_id = self._transform.trans_id_file_id(file_id)
1856
kind = self._transform._new_contents.get(trans_id)
1858
return self._transform._tree.get_file_sha1(file_id)
1860
fileobj = self.get_file(file_id)
1862
return sha_file(fileobj)
1866
def is_executable(self, file_id, path=None):
1869
trans_id = self._transform.trans_id_file_id(file_id)
1871
return self._transform._new_executability[trans_id]
1874
return self._transform._tree.is_executable(file_id, path)
1876
if e.errno == errno.ENOENT:
1879
except errors.NoSuchId:
1882
def path_content_summary(self, path):
1883
trans_id = self._path2trans_id(path)
1884
tt = self._transform
1885
tree_path = tt._tree_id_paths.get(trans_id)
1886
kind = tt._new_contents.get(trans_id)
1888
if tree_path is None or trans_id in tt._removed_contents:
1889
return 'missing', None, None, None
1890
summary = tt._tree.path_content_summary(tree_path)
1891
kind, size, executable, link_or_sha1 = summary
1894
limbo_name = tt._limbo_name(trans_id)
1895
if trans_id in tt._new_reference_revision:
1896
kind = 'tree-reference'
1898
statval = os.lstat(limbo_name)
1899
size = statval.st_size
1900
if not supports_executable():
1903
executable = statval.st_mode & S_IEXEC
1907
if kind == 'symlink':
1908
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1909
if supports_executable():
1910
executable = tt._new_executability.get(trans_id, executable)
1911
return kind, size, executable, link_or_sha1
1913
def iter_changes(self, from_tree, include_unchanged=False,
1914
specific_files=None, pb=None, extra_trees=None,
1915
require_versioned=True, want_unversioned=False):
1916
"""See InterTree.iter_changes.
1918
This has a fast path that is only used when the from_tree matches
1919
the transform tree, and no fancy options are supplied.
1921
if (from_tree is not self._transform._tree or include_unchanged or
1922
specific_files or want_unversioned):
1923
return tree.InterTree(from_tree, self).iter_changes(
1924
include_unchanged=include_unchanged,
1925
specific_files=specific_files,
1927
extra_trees=extra_trees,
1928
require_versioned=require_versioned,
1929
want_unversioned=want_unversioned)
1930
if want_unversioned:
1931
raise ValueError('want_unversioned is not supported')
1932
return self._transform.iter_changes()
1934
def get_file(self, file_id, path=None):
1935
"""See Tree.get_file"""
1936
if not self._content_change(file_id):
1937
return self._transform._tree.get_file(file_id, path)
1938
trans_id = self._transform.trans_id_file_id(file_id)
1939
name = self._transform._limbo_name(trans_id)
1940
return open(name, 'rb')
1942
def get_file_with_stat(self, file_id, path=None):
1943
return self.get_file(file_id, path), None
1945
def annotate_iter(self, file_id,
1946
default_revision=_mod_revision.CURRENT_REVISION):
1947
changes = self._changes(file_id)
1951
changed_content, versioned, kind = (changes[2], changes[3],
1955
get_old = (kind[0] == 'file' and versioned[0])
1957
old_annotation = self._transform._tree.annotate_iter(file_id,
1958
default_revision=default_revision)
1962
return old_annotation
1963
if not changed_content:
1964
return old_annotation
1965
# TODO: This is doing something similar to what WT.annotate_iter is
1966
# doing, however it fails slightly because it doesn't know what
1967
# the *other* revision_id is, so it doesn't know how to give the
1968
# other as the origin for some lines, they all get
1969
# 'default_revision'
1970
# It would be nice to be able to use the new Annotator based
1971
# approach, as well.
1972
return annotate.reannotate([old_annotation],
1973
self.get_file(file_id).readlines(),
1976
def get_symlink_target(self, file_id):
1977
"""See Tree.get_symlink_target"""
1978
if not self._content_change(file_id):
1979
return self._transform._tree.get_symlink_target(file_id)
1980
trans_id = self._transform.trans_id_file_id(file_id)
1981
name = self._transform._limbo_name(trans_id)
1982
return osutils.readlink(name)
1984
def walkdirs(self, prefix=''):
1985
pending = [self._transform.root]
1986
while len(pending) > 0:
1987
parent_id = pending.pop()
1990
prefix = prefix.rstrip('/')
1991
parent_path = self._final_paths.get_path(parent_id)
1992
parent_file_id = self._transform.final_file_id(parent_id)
1993
for child_id in self._all_children(parent_id):
1994
path_from_root = self._final_paths.get_path(child_id)
1995
basename = self._transform.final_name(child_id)
1996
file_id = self._transform.final_file_id(child_id)
1998
kind = self._transform.final_kind(child_id)
1999
versioned_kind = kind
2002
versioned_kind = self._transform._tree.stored_kind(file_id)
2003
if versioned_kind == 'directory':
2004
subdirs.append(child_id)
2005
children.append((path_from_root, basename, kind, None,
2006
file_id, versioned_kind))
2008
if parent_path.startswith(prefix):
2009
yield (parent_path, parent_file_id), children
2010
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2013
def get_parent_ids(self):
2014
return self._parent_ids
2016
def set_parent_ids(self, parent_ids):
2017
self._parent_ids = parent_ids
2019
def get_revision_tree(self, revision_id):
2020
return self._transform._tree.get_revision_tree(revision_id)
2023
def joinpath(parent, child):
2024
"""Join tree-relative paths, handling the tree root specially"""
2025
if parent is None or parent == "":
2028
return pathjoin(parent, child)
2031
class FinalPaths(object):
2032
"""Make path calculation cheap by memoizing paths.
2034
The underlying tree must not be manipulated between calls, or else
2035
the results will likely be incorrect.
2037
def __init__(self, transform):
2038
object.__init__(self)
2039
self._known_paths = {}
2040
self.transform = transform
2042
def _determine_path(self, trans_id):
2043
if trans_id == self.transform.root:
2045
name = self.transform.final_name(trans_id)
2046
parent_id = self.transform.final_parent(trans_id)
2047
if parent_id == self.transform.root:
2050
return pathjoin(self.get_path(parent_id), name)
2052
def get_path(self, trans_id):
2053
"""Find the final path associated with a trans_id"""
2054
if trans_id not in self._known_paths:
2055
self._known_paths[trans_id] = self._determine_path(trans_id)
2056
return self._known_paths[trans_id]
2058
def get_paths(self, trans_ids):
2059
return [(self.get_path(t), t) for t in trans_ids]
2063
def topology_sorted_ids(tree):
2064
"""Determine the topological order of the ids in a tree"""
2065
file_ids = list(tree)
2066
file_ids.sort(key=tree.id2path)
2070
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2071
delta_from_tree=False):
2072
"""Create working tree for a branch, using a TreeTransform.
2074
This function should be used on empty trees, having a tree root at most.
2075
(see merge and revert functionality for working with existing trees)
2077
Existing files are handled like so:
2079
- Existing bzrdirs take precedence over creating new items. They are
2080
created as '%s.diverted' % name.
2081
- Otherwise, if the content on disk matches the content we are building,
2082
it is silently replaced.
2083
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2085
:param tree: The tree to convert wt into a copy of
2086
:param wt: The working tree that files will be placed into
2087
:param accelerator_tree: A tree which can be used for retrieving file
2088
contents more quickly than tree itself, i.e. a workingtree. tree
2089
will be used for cases where accelerator_tree's content is different.
2090
:param hardlink: If true, hard-link files to accelerator_tree, where
2091
possible. accelerator_tree must implement abspath, i.e. be a
2093
:param delta_from_tree: If true, build_tree may use the input Tree to
2094
generate the inventory delta.
2096
wt.lock_tree_write()
2100
if accelerator_tree is not None:
2101
accelerator_tree.lock_read()
2103
return _build_tree(tree, wt, accelerator_tree, hardlink,
2106
if accelerator_tree is not None:
2107
accelerator_tree.unlock()
2114
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2115
"""See build_tree."""
2116
for num, _unused in enumerate(wt.all_file_ids()):
2117
if num > 0: # more than just a root
2118
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2119
existing_files = set()
2120
for dir, files in wt.walkdirs():
2121
existing_files.update(f[0] for f in files)
2123
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2124
pp = ProgressPhase("Build phase", 2, top_pb)
2125
if tree.inventory.root is not None:
2126
# This is kind of a hack: we should be altering the root
2127
# as part of the regular tree shape diff logic.
2128
# The conditional test here is to avoid doing an
2129
# expensive operation (flush) every time the root id
2130
# is set within the tree, nor setting the root and thus
2131
# marking the tree as dirty, because we use two different
2132
# idioms here: tree interfaces and inventory interfaces.
2133
if wt.get_root_id() != tree.get_root_id():
2134
wt.set_root_id(tree.get_root_id())
2136
tt = TreeTransform(wt)
2140
file_trans_id[wt.get_root_id()] = \
2141
tt.trans_id_tree_file_id(wt.get_root_id())
2142
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2144
deferred_contents = []
2146
total = len(tree.inventory)
2148
precomputed_delta = []
2150
precomputed_delta = None
2151
for num, (tree_path, entry) in \
2152
enumerate(tree.inventory.iter_entries_by_dir()):
2153
pb.update("Building tree", num - len(deferred_contents), total)
2154
if entry.parent_id is None:
2157
file_id = entry.file_id
2159
precomputed_delta.append((None, tree_path, file_id, entry))
2160
if tree_path in existing_files:
2161
target_path = wt.abspath(tree_path)
2162
kind = file_kind(target_path)
2163
if kind == "directory":
2165
bzrdir.BzrDir.open(target_path)
2166
except errors.NotBranchError:
2170
if (file_id not in divert and
2171
_content_match(tree, entry, file_id, kind,
2173
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2174
if kind == 'directory':
2176
parent_id = file_trans_id[entry.parent_id]
2177
if entry.kind == 'file':
2178
# We *almost* replicate new_by_entry, so that we can defer
2179
# getting the file text, and get them all at once.
2180
trans_id = tt.create_path(entry.name, parent_id)
2181
file_trans_id[file_id] = trans_id
2182
tt.version_file(file_id, trans_id)
2183
executable = tree.is_executable(file_id, tree_path)
2185
tt.set_executability(executable, trans_id)
2186
trans_data = (trans_id, tree_path)
2187
deferred_contents.append((file_id, trans_data))
2189
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2192
new_trans_id = file_trans_id[file_id]
2193
old_parent = tt.trans_id_tree_path(tree_path)
2194
_reparent_children(tt, old_parent, new_trans_id)
2195
offset = num + 1 - len(deferred_contents)
2196
_create_files(tt, tree, deferred_contents, pb, offset,
2197
accelerator_tree, hardlink)
2201
divert_trans = set(file_trans_id[f] for f in divert)
2202
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2203
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2204
if len(raw_conflicts) > 0:
2205
precomputed_delta = None
2206
conflicts = cook_conflicts(raw_conflicts, tt)
2207
for conflict in conflicts:
2210
wt.add_conflicts(conflicts)
2211
except errors.UnsupportedOperation:
2213
result = tt.apply(no_conflicts=True,
2214
precomputed_delta=precomputed_delta)
2221
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2223
total = len(desired_files) + offset
2225
if accelerator_tree is None:
2226
new_desired_files = desired_files
2228
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2229
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2230
in iter if not (c or e[0] != e[1]))
2231
new_desired_files = []
2233
for file_id, (trans_id, tree_path) in desired_files:
2234
accelerator_path = unchanged.get(file_id)
2235
if accelerator_path is None:
2236
new_desired_files.append((file_id, (trans_id, tree_path)))
2238
pb.update('Adding file contents', count + offset, total)
2240
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2243
contents = accelerator_tree.get_file(file_id, accelerator_path)
2244
if wt.supports_content_filtering():
2245
filters = wt._content_filter_stack(tree_path)
2246
contents = filtered_output_bytes(contents, filters,
2247
ContentFilterContext(tree_path, tree))
2249
tt.create_file(contents, trans_id)
2253
except AttributeError:
2254
# after filtering, contents may no longer be file-like
2258
for count, ((trans_id, tree_path), contents) in enumerate(
2259
tree.iter_files_bytes(new_desired_files)):
2260
if wt.supports_content_filtering():
2261
filters = wt._content_filter_stack(tree_path)
2262
contents = filtered_output_bytes(contents, filters,
2263
ContentFilterContext(tree_path, tree))
2264
tt.create_file(contents, trans_id)
2265
pb.update('Adding file contents', count + offset, total)
2268
def _reparent_children(tt, old_parent, new_parent):
2269
for child in tt.iter_tree_children(old_parent):
2270
tt.adjust_path(tt.final_name(child), new_parent, child)
2272
def _reparent_transform_children(tt, old_parent, new_parent):
2273
by_parent = tt.by_parent()
2274
for child in by_parent[old_parent]:
2275
tt.adjust_path(tt.final_name(child), new_parent, child)
2276
return by_parent[old_parent]
2278
def _content_match(tree, entry, file_id, kind, target_path):
2279
if entry.kind != kind:
2281
if entry.kind == "directory":
2283
if entry.kind == "file":
2284
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2286
elif entry.kind == "symlink":
2287
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2292
def resolve_checkout(tt, conflicts, divert):
2293
new_conflicts = set()
2294
for c_type, conflict in ((c[0], c) for c in conflicts):
2295
# Anything but a 'duplicate' would indicate programmer error
2296
if c_type != 'duplicate':
2297
raise AssertionError(c_type)
2298
# Now figure out which is new and which is old
2299
if tt.new_contents(conflict[1]):
2300
new_file = conflict[1]
2301
old_file = conflict[2]
2303
new_file = conflict[2]
2304
old_file = conflict[1]
2306
# We should only get here if the conflict wasn't completely
2308
final_parent = tt.final_parent(old_file)
2309
if new_file in divert:
2310
new_name = tt.final_name(old_file)+'.diverted'
2311
tt.adjust_path(new_name, final_parent, new_file)
2312
new_conflicts.add((c_type, 'Diverted to',
2313
new_file, old_file))
2315
new_name = tt.final_name(old_file)+'.moved'
2316
tt.adjust_path(new_name, final_parent, old_file)
2317
new_conflicts.add((c_type, 'Moved existing file to',
2318
old_file, new_file))
2319
return new_conflicts
2322
def new_by_entry(tt, entry, parent_id, tree):
2323
"""Create a new file according to its inventory entry"""
2327
contents = tree.get_file(entry.file_id).readlines()
2328
executable = tree.is_executable(entry.file_id)
2329
return tt.new_file(name, parent_id, contents, entry.file_id,
2331
elif kind in ('directory', 'tree-reference'):
2332
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2333
if kind == 'tree-reference':
2334
tt.set_tree_reference(entry.reference_revision, trans_id)
2336
elif kind == 'symlink':
2337
target = tree.get_symlink_target(entry.file_id)
2338
return tt.new_symlink(name, parent_id, target, entry.file_id)
2340
raise errors.BadFileKindError(name, kind)
2343
@deprecated_function(deprecated_in((1, 9, 0)))
2344
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2345
"""Create new file contents according to an inventory entry.
2347
DEPRECATED. Use create_from_tree instead.
2349
if entry.kind == "file":
2351
lines = tree.get_file(entry.file_id).readlines()
2352
tt.create_file(lines, trans_id, mode_id=mode_id)
2353
elif entry.kind == "symlink":
2354
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2355
elif entry.kind == "directory":
2356
tt.create_directory(trans_id)
2359
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2360
"""Create new file contents according to tree contents."""
2361
kind = tree.kind(file_id)
2362
if kind == 'directory':
2363
tt.create_directory(trans_id)
2364
elif kind == "file":
2366
tree_file = tree.get_file(file_id)
2368
bytes = tree_file.readlines()
2371
tt.create_file(bytes, trans_id)
2372
elif kind == "symlink":
2373
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2375
raise AssertionError('Unknown kind %r' % kind)
2378
def create_entry_executability(tt, entry, trans_id):
2379
"""Set the executability of a trans_id according to an inventory entry"""
2380
if entry.kind == "file":
2381
tt.set_executability(entry.executable, trans_id)
2384
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2385
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2388
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2389
"""Produce a backup-style name that appears to be available"""
2393
yield "%s.~%d~" % (name, counter)
2395
for new_name in name_gen():
2396
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2400
def _entry_changes(file_id, entry, working_tree):
2401
"""Determine in which ways the inventory entry has changed.
2403
Returns booleans: has_contents, content_mod, meta_mod
2404
has_contents means there are currently contents, but they differ
2405
contents_mod means contents need to be modified
2406
meta_mod means the metadata needs to be modified
2408
cur_entry = working_tree.inventory[file_id]
2410
working_kind = working_tree.kind(file_id)
2413
has_contents = False
2416
if has_contents is True:
2417
if entry.kind != working_kind:
2418
contents_mod, meta_mod = True, False
2420
cur_entry._read_tree_state(working_tree.id2path(file_id),
2422
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2423
cur_entry._forget_tree_state()
2424
return has_contents, contents_mod, meta_mod
2427
def revert(working_tree, target_tree, filenames, backups=False,
2428
pb=DummyProgress(), change_reporter=None):
2429
"""Revert a working tree's contents to those of a target tree."""
2430
target_tree.lock_read()
2431
tt = TreeTransform(working_tree, pb)
2433
pp = ProgressPhase("Revert phase", 3, pb)
2434
conflicts, merge_modified = _prepare_revert_transform(
2435
working_tree, target_tree, tt, filenames, backups, pp)
2437
change_reporter = delta._ChangeReporter(
2438
unversioned_filter=working_tree.is_ignored)
2439
delta.report_changes(tt.iter_changes(), change_reporter)
2440
for conflict in conflicts:
2444
working_tree.set_merge_modified(merge_modified)
2446
target_tree.unlock()
2452
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2453
backups, pp, basis_tree=None,
2454
merge_modified=None):
2456
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2458
if merge_modified is None:
2459
merge_modified = working_tree.merge_modified()
2460
merge_modified = _alter_files(working_tree, target_tree, tt,
2461
child_pb, filenames, backups,
2462
merge_modified, basis_tree)
2466
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2468
raw_conflicts = resolve_conflicts(tt, child_pb,
2469
lambda t, c: conflict_pass(t, c, target_tree))
2472
conflicts = cook_conflicts(raw_conflicts, tt)
2473
return conflicts, merge_modified
2476
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2477
backups, merge_modified, basis_tree=None):
2478
if basis_tree is not None:
2479
basis_tree.lock_read()
2480
change_list = target_tree.iter_changes(working_tree,
2481
specific_files=specific_files, pb=pb)
2482
if target_tree.get_root_id() is None:
2488
for id_num, (file_id, path, changed_content, versioned, parent, name,
2489
kind, executable) in enumerate(change_list):
2490
if skip_root and file_id[0] is not None and parent[0] is None:
2492
trans_id = tt.trans_id_file_id(file_id)
2495
keep_content = False
2496
if kind[0] == 'file' and (backups or kind[1] is None):
2497
wt_sha1 = working_tree.get_file_sha1(file_id)
2498
if merge_modified.get(file_id) != wt_sha1:
2499
# acquire the basis tree lazily to prevent the
2500
# expense of accessing it when it's not needed ?
2501
# (Guessing, RBC, 200702)
2502
if basis_tree is None:
2503
basis_tree = working_tree.basis_tree()
2504
basis_tree.lock_read()
2505
if file_id in basis_tree:
2506
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2508
elif kind[1] is None and not versioned[1]:
2510
if kind[0] is not None:
2511
if not keep_content:
2512
tt.delete_contents(trans_id)
2513
elif kind[1] is not None:
2514
parent_trans_id = tt.trans_id_file_id(parent[0])
2515
by_parent = tt.by_parent()
2516
backup_name = _get_backup_name(name[0], by_parent,
2517
parent_trans_id, tt)
2518
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2519
new_trans_id = tt.create_path(name[0], parent_trans_id)
2520
if versioned == (True, True):
2521
tt.unversion_file(trans_id)
2522
tt.version_file(file_id, new_trans_id)
2523
# New contents should have the same unix perms as old
2526
trans_id = new_trans_id
2527
if kind[1] in ('directory', 'tree-reference'):
2528
tt.create_directory(trans_id)
2529
if kind[1] == 'tree-reference':
2530
revision = target_tree.get_reference_revision(file_id,
2532
tt.set_tree_reference(revision, trans_id)
2533
elif kind[1] == 'symlink':
2534
tt.create_symlink(target_tree.get_symlink_target(file_id),
2536
elif kind[1] == 'file':
2537
deferred_files.append((file_id, (trans_id, mode_id)))
2538
if basis_tree is None:
2539
basis_tree = working_tree.basis_tree()
2540
basis_tree.lock_read()
2541
new_sha1 = target_tree.get_file_sha1(file_id)
2542
if (file_id in basis_tree and new_sha1 ==
2543
basis_tree.get_file_sha1(file_id)):
2544
if file_id in merge_modified:
2545
del merge_modified[file_id]
2547
merge_modified[file_id] = new_sha1
2549
# preserve the execute bit when backing up
2550
if keep_content and executable[0] == executable[1]:
2551
tt.set_executability(executable[1], trans_id)
2552
elif kind[1] is not None:
2553
raise AssertionError(kind[1])
2554
if versioned == (False, True):
2555
tt.version_file(file_id, trans_id)
2556
if versioned == (True, False):
2557
tt.unversion_file(trans_id)
2558
if (name[1] is not None and
2559
(name[0] != name[1] or parent[0] != parent[1])):
2560
if name[1] == '' and parent[1] is None:
2561
parent_trans = ROOT_PARENT
2563
parent_trans = tt.trans_id_file_id(parent[1])
2564
tt.adjust_path(name[1], parent_trans, trans_id)
2565
if executable[0] != executable[1] and kind[1] == "file":
2566
tt.set_executability(executable[1], trans_id)
2567
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2569
tt.create_file(bytes, trans_id, mode_id)
2571
if basis_tree is not None:
2573
return merge_modified
2576
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2577
"""Make many conflict-resolution attempts, but die if they fail"""
2578
if pass_func is None:
2579
pass_func = conflict_pass
2580
new_conflicts = set()
2583
pb.update('Resolution pass', n+1, 10)
2584
conflicts = tt.find_conflicts()
2585
if len(conflicts) == 0:
2586
return new_conflicts
2587
new_conflicts.update(pass_func(tt, conflicts))
2588
raise MalformedTransform(conflicts=conflicts)
2593
def conflict_pass(tt, conflicts, path_tree=None):
2594
"""Resolve some classes of conflicts.
2596
:param tt: The transform to resolve conflicts in
2597
:param conflicts: The conflicts to resolve
2598
:param path_tree: A Tree to get supplemental paths from
2600
new_conflicts = set()
2601
for c_type, conflict in ((c[0], c) for c in conflicts):
2602
if c_type == 'duplicate id':
2603
tt.unversion_file(conflict[1])
2604
new_conflicts.add((c_type, 'Unversioned existing file',
2605
conflict[1], conflict[2], ))
2606
elif c_type == 'duplicate':
2607
# files that were renamed take precedence
2608
final_parent = tt.final_parent(conflict[1])
2609
if tt.path_changed(conflict[1]):
2610
existing_file, new_file = conflict[2], conflict[1]
2612
existing_file, new_file = conflict[1], conflict[2]
2613
new_name = tt.final_name(existing_file)+'.moved'
2614
tt.adjust_path(new_name, final_parent, existing_file)
2615
new_conflicts.add((c_type, 'Moved existing file to',
2616
existing_file, new_file))
2617
elif c_type == 'parent loop':
2618
# break the loop by undoing one of the ops that caused the loop
2620
while not tt.path_changed(cur):
2621
cur = tt.final_parent(cur)
2622
new_conflicts.add((c_type, 'Cancelled move', cur,
2623
tt.final_parent(cur),))
2624
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2626
elif c_type == 'missing parent':
2627
trans_id = conflict[1]
2629
tt.cancel_deletion(trans_id)
2630
new_conflicts.add(('deleting parent', 'Not deleting',
2635
tt.final_name(trans_id)
2637
if path_tree is not None:
2638
file_id = tt.final_file_id(trans_id)
2640
file_id = tt.inactive_file_id(trans_id)
2641
entry = path_tree.inventory[file_id]
2642
# special-case the other tree root (move its
2643
# children to current root)
2644
if entry.parent_id is None:
2646
moved = _reparent_transform_children(
2647
tt, trans_id, tt.root)
2649
new_conflicts.add((c_type, 'Moved to root',
2652
parent_trans_id = tt.trans_id_file_id(
2654
tt.adjust_path(entry.name, parent_trans_id,
2657
tt.create_directory(trans_id)
2658
new_conflicts.add((c_type, 'Created directory', trans_id))
2659
elif c_type == 'unversioned parent':
2660
file_id = tt.inactive_file_id(conflict[1])
2661
# special-case the other tree root (move its children instead)
2662
if path_tree and file_id in path_tree:
2663
if path_tree.inventory[file_id].parent_id is None:
2665
tt.version_file(file_id, conflict[1])
2666
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2667
elif c_type == 'non-directory parent':
2668
parent_id = conflict[1]
2669
parent_parent = tt.final_parent(parent_id)
2670
parent_name = tt.final_name(parent_id)
2671
parent_file_id = tt.final_file_id(parent_id)
2672
new_parent_id = tt.new_directory(parent_name + '.new',
2673
parent_parent, parent_file_id)
2674
_reparent_transform_children(tt, parent_id, new_parent_id)
2675
if parent_file_id is not None:
2676
tt.unversion_file(parent_id)
2677
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2678
elif c_type == 'versioning no contents':
2679
tt.cancel_versioning(conflict[1])
2680
return new_conflicts
2683
def cook_conflicts(raw_conflicts, tt):
2684
"""Generate a list of cooked conflicts, sorted by file path"""
2685
from bzrlib.conflicts import Conflict
2686
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2687
return sorted(conflict_iter, key=Conflict.sort_key)
2690
def iter_cook_conflicts(raw_conflicts, tt):
2691
from bzrlib.conflicts import Conflict
2693
for conflict in raw_conflicts:
2694
c_type = conflict[0]
2695
action = conflict[1]
2696
modified_path = fp.get_path(conflict[2])
2697
modified_id = tt.final_file_id(conflict[2])
2698
if len(conflict) == 3:
2699
yield Conflict.factory(c_type, action=action, path=modified_path,
2700
file_id=modified_id)
2703
conflicting_path = fp.get_path(conflict[3])
2704
conflicting_id = tt.final_file_id(conflict[3])
2705
yield Conflict.factory(c_type, action=action, path=modified_path,
2706
file_id=modified_id,
2707
conflict_path=conflicting_path,
2708
conflict_file_id=conflicting_id)
2711
class _FileMover(object):
2712
"""Moves and deletes files for TreeTransform, tracking operations"""
2715
self.past_renames = []
2716
self.pending_deletions = []
2718
def rename(self, from_, to):
2719
"""Rename a file from one path to another. Functions like os.rename"""
2721
os.rename(from_, to)
2723
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2724
raise errors.FileExists(to, str(e))
2726
self.past_renames.append((from_, to))
2728
def pre_delete(self, from_, to):
2729
"""Rename a file out of the way and mark it for deletion.
2731
Unlike os.unlink, this works equally well for files and directories.
2732
:param from_: The current file path
2733
:param to: A temporary path for the file
2735
self.rename(from_, to)
2736
self.pending_deletions.append(to)
2739
"""Reverse all renames that have been performed"""
2740
for from_, to in reversed(self.past_renames):
2741
os.rename(to, from_)
2742
# after rollback, don't reuse _FileMover
2744
pending_deletions = None
2746
def apply_deletions(self):
2747
"""Apply all marked deletions"""
2748
for path in self.pending_deletions:
2750
# after apply_deletions, don't reuse _FileMover
2752
pending_deletions = None
added
removed
bzrlib/transform.py
