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 commit(self, branch, message, merge_parents=None, strict=False):
863
"""Commit the result of this TreeTransform to a branch.
865
:param branch: The branch to commit to.
866
:param message: The message to attach to the commit.
867
:param merge_parents: Additional parents specified by pending merges.
868
:return: The revision_id of the revision committed.
871
unversioned = set(self._new_contents).difference(set(self._new_id))
872
for trans_id in unversioned:
873
if self.final_file_id(trans_id) is None:
874
raise errors.StrictCommitFailed()
876
revno, last_rev_id = branch.last_revision_info()
877
if last_rev_id == _mod_revision.NULL_REVISION:
878
if merge_parents is not None:
879
raise ValueError('Cannot supply merge parents for first'
883
parent_ids = [last_rev_id]
884
if merge_parents is not None:
885
parent_ids.extend(merge_parents)
886
if self._tree.get_revision_id() != last_rev_id:
887
raise ValueError('TreeTransform not based on branch basis: %s' %
888
self._tree.get_revision_id())
889
builder = branch.get_commit_builder(parent_ids)
890
preview = self.get_preview_tree()
891
list(builder.record_iter_changes(preview, last_rev_id,
892
self.iter_changes()))
893
builder.finish_inventory()
894
revision_id = builder.commit(message)
895
branch.set_last_revision_info(revno + 1, revision_id)
898
def _text_parent(self, trans_id):
899
file_id = self.tree_file_id(trans_id)
901
if file_id is None or self._tree.kind(file_id) != 'file':
903
except errors.NoSuchFile:
907
def _get_parents_texts(self, trans_id):
908
"""Get texts for compression parents of this file."""
909
file_id = self._text_parent(trans_id)
912
return (self._tree.get_file_text(file_id),)
914
def _get_parents_lines(self, trans_id):
915
"""Get lines for compression parents of this file."""
916
file_id = self._text_parent(trans_id)
919
return (self._tree.get_file_lines(file_id),)
921
def serialize(self, serializer):
922
"""Serialize this TreeTransform.
924
:param serializer: A Serialiser like pack.ContainerSerializer.
926
new_name = dict((k, v.encode('utf-8')) for k, v in
927
self._new_name.items())
928
new_executability = dict((k, int(v)) for k, v in
929
self._new_executability.items())
930
tree_path_ids = dict((k.encode('utf-8'), v)
931
for k, v in self._tree_path_ids.items())
933
'_id_number': self._id_number,
934
'_new_name': new_name,
935
'_new_parent': self._new_parent,
936
'_new_executability': new_executability,
937
'_new_id': self._new_id,
938
'_tree_path_ids': tree_path_ids,
939
'_removed_id': list(self._removed_id),
940
'_removed_contents': list(self._removed_contents),
941
'_non_present_ids': self._non_present_ids,
943
yield serializer.bytes_record(bencode.bencode(attribs),
945
for trans_id, kind in self._new_contents.items():
947
lines = osutils.chunks_to_lines(
948
self._read_file_chunks(trans_id))
949
parents = self._get_parents_lines(trans_id)
950
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
951
content = ''.join(mpdiff.to_patch())
952
if kind == 'directory':
954
if kind == 'symlink':
955
content = self._read_symlink_target(trans_id)
956
yield serializer.bytes_record(content, ((trans_id, kind),))
958
def deserialize(self, records):
959
"""Deserialize a stored TreeTransform.
961
:param records: An iterable of (names, content) tuples, as per
962
pack.ContainerPushParser.
964
names, content = records.next()
965
attribs = bencode.bdecode(content)
966
self._id_number = attribs['_id_number']
967
self._new_name = dict((k, v.decode('utf-8'))
968
for k, v in attribs['_new_name'].items())
969
self._new_parent = attribs['_new_parent']
970
self._new_executability = dict((k, bool(v)) for k, v in
971
attribs['_new_executability'].items())
972
self._new_id = attribs['_new_id']
973
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
974
self._tree_path_ids = {}
975
self._tree_id_paths = {}
976
for bytepath, trans_id in attribs['_tree_path_ids'].items():
977
path = bytepath.decode('utf-8')
978
self._tree_path_ids[path] = trans_id
979
self._tree_id_paths[trans_id] = path
980
self._removed_id = set(attribs['_removed_id'])
981
self._removed_contents = set(attribs['_removed_contents'])
982
self._non_present_ids = attribs['_non_present_ids']
983
for ((trans_id, kind),), content in records:
985
mpdiff = multiparent.MultiParent.from_patch(content)
986
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
987
self.create_file(lines, trans_id)
988
if kind == 'directory':
989
self.create_directory(trans_id)
990
if kind == 'symlink':
991
self.create_symlink(content.decode('utf-8'), trans_id)
994
class DiskTreeTransform(TreeTransformBase):
995
"""Tree transform storing its contents on disk."""
997
def __init__(self, tree, limbodir, pb=DummyProgress(),
998
case_sensitive=True):
1000
:param tree: The tree that will be transformed, but not necessarily
1002
:param limbodir: A directory where new files can be stored until
1003
they are installed in their proper places
1004
:param pb: A ProgressBar indicating how much progress is being made
1005
:param case_sensitive: If True, the target of the transform is
1006
case sensitive, not just case preserving.
1008
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1009
self._limbodir = limbodir
1010
self._deletiondir = None
1011
# A mapping of transform ids to their limbo filename
1012
self._limbo_files = {}
1013
# A mapping of transform ids to a set of the transform ids of children
1014
# that their limbo directory has
1015
self._limbo_children = {}
1016
# Map transform ids to maps of child filename to child transform id
1017
self._limbo_children_names = {}
1018
# List of transform ids that need to be renamed from limbo into place
1019
self._needs_rename = set()
1022
"""Release the working tree lock, if held, clean up limbo dir.
1024
This is required if apply has not been invoked, but can be invoked
1027
if self._tree is None:
1030
entries = [(self._limbo_name(t), t, k) for t, k in
1031
self._new_contents.iteritems()]
1032
entries.sort(reverse=True)
1033
for path, trans_id, kind in entries:
1036
delete_any(self._limbodir)
1038
# We don't especially care *why* the dir is immortal.
1039
raise ImmortalLimbo(self._limbodir)
1041
if self._deletiondir is not None:
1042
delete_any(self._deletiondir)
1044
raise errors.ImmortalPendingDeletion(self._deletiondir)
1046
TreeTransformBase.finalize(self)
1048
def _limbo_name(self, trans_id):
1049
"""Generate the limbo name of a file"""
1050
limbo_name = self._limbo_files.get(trans_id)
1051
if limbo_name is not None:
1053
parent = self._new_parent.get(trans_id)
1054
# if the parent directory is already in limbo (e.g. when building a
1055
# tree), choose a limbo name inside the parent, to reduce further
1057
use_direct_path = False
1058
if self._new_contents.get(parent) == 'directory':
1059
filename = self._new_name.get(trans_id)
1060
if filename is not None:
1061
if parent not in self._limbo_children:
1062
self._limbo_children[parent] = set()
1063
self._limbo_children_names[parent] = {}
1064
use_direct_path = True
1065
# the direct path can only be used if no other file has
1066
# already taken this pathname, i.e. if the name is unused, or
1067
# if it is already associated with this trans_id.
1068
elif self._case_sensitive_target:
1069
if (self._limbo_children_names[parent].get(filename)
1070
in (trans_id, None)):
1071
use_direct_path = True
1073
for l_filename, l_trans_id in\
1074
self._limbo_children_names[parent].iteritems():
1075
if l_trans_id == trans_id:
1077
if l_filename.lower() == filename.lower():
1080
use_direct_path = True
1083
limbo_name = pathjoin(self._limbo_files[parent], filename)
1084
self._limbo_children[parent].add(trans_id)
1085
self._limbo_children_names[parent][filename] = trans_id
1087
limbo_name = pathjoin(self._limbodir, trans_id)
1088
self._needs_rename.add(trans_id)
1089
self._limbo_files[trans_id] = limbo_name
1092
def adjust_path(self, name, parent, trans_id):
1093
previous_parent = self._new_parent.get(trans_id)
1094
previous_name = self._new_name.get(trans_id)
1095
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1096
if (trans_id in self._limbo_files and
1097
trans_id not in self._needs_rename):
1098
self._rename_in_limbo([trans_id])
1099
self._limbo_children[previous_parent].remove(trans_id)
1100
del self._limbo_children_names[previous_parent][previous_name]
1102
def _rename_in_limbo(self, trans_ids):
1103
"""Fix limbo names so that the right final path is produced.
1105
This means we outsmarted ourselves-- we tried to avoid renaming
1106
these files later by creating them with their final names in their
1107
final parents. But now the previous name or parent is no longer
1108
suitable, so we have to rename them.
1110
Even for trans_ids that have no new contents, we must remove their
1111
entries from _limbo_files, because they are now stale.
1113
for trans_id in trans_ids:
1114
old_path = self._limbo_files.pop(trans_id)
1115
if trans_id not in self._new_contents:
1117
new_path = self._limbo_name(trans_id)
1118
os.rename(old_path, new_path)
1120
def create_file(self, contents, trans_id, mode_id=None):
1121
"""Schedule creation of a new file.
1125
Contents is an iterator of strings, all of which will be written
1126
to the target destination.
1128
New file takes the permissions of any existing file with that id,
1129
unless mode_id is specified.
1131
name = self._limbo_name(trans_id)
1132
f = open(name, 'wb')
1135
unique_add(self._new_contents, trans_id, 'file')
1137
# Clean up the file, it never got registered so
1138
# TreeTransform.finalize() won't clean it up.
1143
f.writelines(contents)
1146
self._set_mode(trans_id, mode_id, S_ISREG)
1148
def _read_file_chunks(self, trans_id):
1149
cur_file = open(self._limbo_name(trans_id), 'rb')
1151
return cur_file.readlines()
1155
def _read_symlink_target(self, trans_id):
1156
return os.readlink(self._limbo_name(trans_id))
1158
def create_hardlink(self, path, trans_id):
1159
"""Schedule creation of a hard link"""
1160
name = self._limbo_name(trans_id)
1164
if e.errno != errno.EPERM:
1166
raise errors.HardLinkNotSupported(path)
1168
unique_add(self._new_contents, trans_id, 'file')
1170
# Clean up the file, it never got registered so
1171
# TreeTransform.finalize() won't clean it up.
1175
def create_directory(self, trans_id):
1176
"""Schedule creation of a new directory.
1178
See also new_directory.
1180
os.mkdir(self._limbo_name(trans_id))
1181
unique_add(self._new_contents, trans_id, 'directory')
1183
def create_symlink(self, target, trans_id):
1184
"""Schedule creation of a new symbolic link.
1186
target is a bytestring.
1187
See also new_symlink.
1190
os.symlink(target, self._limbo_name(trans_id))
1191
unique_add(self._new_contents, trans_id, 'symlink')
1194
path = FinalPaths(self).get_path(trans_id)
1197
raise UnableCreateSymlink(path=path)
1199
def cancel_creation(self, trans_id):
1200
"""Cancel the creation of new file contents."""
1201
del self._new_contents[trans_id]
1202
children = self._limbo_children.get(trans_id)
1203
# if this is a limbo directory with children, move them before removing
1205
if children is not None:
1206
self._rename_in_limbo(children)
1207
del self._limbo_children[trans_id]
1208
del self._limbo_children_names[trans_id]
1209
delete_any(self._limbo_name(trans_id))
1212
class TreeTransform(DiskTreeTransform):
1213
"""Represent a tree transformation.
1215
This object is designed to support incremental generation of the transform,
1218
However, it gives optimum performance when parent directories are created
1219
before their contents. The transform is then able to put child files
1220
directly in their parent directory, avoiding later renames.
1222
It is easy to produce malformed transforms, but they are generally
1223
harmless. Attempting to apply a malformed transform will cause an
1224
exception to be raised before any modifications are made to the tree.
1226
Many kinds of malformed transforms can be corrected with the
1227
resolve_conflicts function. The remaining ones indicate programming error,
1228
such as trying to create a file with no path.
1230
Two sets of file creation methods are supplied. Convenience methods are:
1235
These are composed of the low-level methods:
1237
* create_file or create_directory or create_symlink
1241
Transform/Transaction ids
1242
-------------------------
1243
trans_ids are temporary ids assigned to all files involved in a transform.
1244
It's possible, even common, that not all files in the Tree have trans_ids.
1246
trans_ids are used because filenames and file_ids are not good enough
1247
identifiers; filenames change, and not all files have file_ids. File-ids
1248
are also associated with trans-ids, so that moving a file moves its
1251
trans_ids are only valid for the TreeTransform that generated them.
1255
Limbo is a temporary directory use to hold new versions of files.
1256
Files are added to limbo by create_file, create_directory, create_symlink,
1257
and their convenience variants (new_*). Files may be removed from limbo
1258
using cancel_creation. Files are renamed from limbo into their final
1259
location as part of TreeTransform.apply
1261
Limbo must be cleaned up, by either calling TreeTransform.apply or
1262
calling TreeTransform.finalize.
1264
Files are placed into limbo inside their parent directories, where
1265
possible. This reduces subsequent renames, and makes operations involving
1266
lots of files faster. This optimization is only possible if the parent
1267
directory is created *before* creating any of its children, so avoid
1268
creating children before parents, where possible.
1272
This temporary directory is used by _FileMover for storing files that are
1273
about to be deleted. In case of rollback, the files will be restored.
1274
FileMover does not delete files until it is sure that a rollback will not
1277
def __init__(self, tree, pb=DummyProgress()):
1278
"""Note: a tree_write lock is taken on the tree.
1280
Use TreeTransform.finalize() to release the lock (can be omitted if
1281
TreeTransform.apply() called).
1283
tree.lock_tree_write()
1286
limbodir = urlutils.local_path_from_url(
1287
tree._transport.abspath('limbo'))
1291
if e.errno == errno.EEXIST:
1292
raise ExistingLimbo(limbodir)
1293
deletiondir = urlutils.local_path_from_url(
1294
tree._transport.abspath('pending-deletion'))
1296
os.mkdir(deletiondir)
1298
if e.errno == errno.EEXIST:
1299
raise errors.ExistingPendingDeletion(deletiondir)
1304
# Cache of realpath results, to speed up canonical_path
1305
self._realpaths = {}
1306
# Cache of relpath results, to speed up canonical_path
1308
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1309
tree.case_sensitive)
1310
self._deletiondir = deletiondir
1312
def canonical_path(self, path):
1313
"""Get the canonical tree-relative path"""
1314
# don't follow final symlinks
1315
abs = self._tree.abspath(path)
1316
if abs in self._relpaths:
1317
return self._relpaths[abs]
1318
dirname, basename = os.path.split(abs)
1319
if dirname not in self._realpaths:
1320
self._realpaths[dirname] = os.path.realpath(dirname)
1321
dirname = self._realpaths[dirname]
1322
abs = pathjoin(dirname, basename)
1323
if dirname in self._relpaths:
1324
relpath = pathjoin(self._relpaths[dirname], basename)
1325
relpath = relpath.rstrip('/\\')
1327
relpath = self._tree.relpath(abs)
1328
self._relpaths[abs] = relpath
1331
def tree_kind(self, trans_id):
1332
"""Determine the file kind in the working tree.
1334
Raises NoSuchFile if the file does not exist
1336
path = self._tree_id_paths.get(trans_id)
1338
raise NoSuchFile(None)
1340
return file_kind(self._tree.abspath(path))
1342
if e.errno != errno.ENOENT:
1345
raise NoSuchFile(path)
1347
def _set_mode(self, trans_id, mode_id, typefunc):
1348
"""Set the mode of new file contents.
1349
The mode_id is the existing file to get the mode from (often the same
1350
as trans_id). The operation is only performed if there's a mode match
1351
according to typefunc.
1356
old_path = self._tree_id_paths[mode_id]
1360
mode = os.stat(self._tree.abspath(old_path)).st_mode
1362
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1363
# Either old_path doesn't exist, or the parent of the
1364
# target is not a directory (but will be one eventually)
1365
# Either way, we know it doesn't exist *right now*
1366
# See also bug #248448
1371
os.chmod(self._limbo_name(trans_id), mode)
1373
def iter_tree_children(self, parent_id):
1374
"""Iterate through the entry's tree children, if any"""
1376
path = self._tree_id_paths[parent_id]
1380
children = os.listdir(self._tree.abspath(path))
1382
if not (osutils._is_error_enotdir(e)
1383
or e.errno in (errno.ENOENT, errno.ESRCH)):
1387
for child in children:
1388
childpath = joinpath(path, child)
1389
if self._tree.is_control_filename(childpath):
1391
yield self.trans_id_tree_path(childpath)
1394
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1395
"""Apply all changes to the inventory and filesystem.
1397
If filesystem or inventory conflicts are present, MalformedTransform
1400
If apply succeeds, finalize is not necessary.
1402
:param no_conflicts: if True, the caller guarantees there are no
1403
conflicts, so no check is made.
1404
:param precomputed_delta: An inventory delta to use instead of
1406
:param _mover: Supply an alternate FileMover, for testing
1408
if not no_conflicts:
1409
conflicts = self.find_conflicts()
1410
if len(conflicts) != 0:
1411
raise MalformedTransform(conflicts=conflicts)
1412
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1414
if precomputed_delta is None:
1415
child_pb.update('Apply phase', 0, 2)
1416
inventory_delta = self._generate_inventory_delta()
1419
inventory_delta = precomputed_delta
1422
mover = _FileMover()
1426
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1427
self._apply_removals(mover)
1428
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1429
modified_paths = self._apply_insertions(mover)
1434
mover.apply_deletions()
1437
self._tree.apply_inventory_delta(inventory_delta)
1440
return _TransformResults(modified_paths, self.rename_count)
1442
def _generate_inventory_delta(self):
1443
"""Generate an inventory delta for the current transform."""
1444
inventory_delta = []
1445
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1446
new_paths = self._inventory_altered()
1447
total_entries = len(new_paths) + len(self._removed_id)
1449
for num, trans_id in enumerate(self._removed_id):
1451
child_pb.update('removing file', num, total_entries)
1452
if trans_id == self._new_root:
1453
file_id = self._tree.get_root_id()
1455
file_id = self.tree_file_id(trans_id)
1456
# File-id isn't really being deleted, just moved
1457
if file_id in self._r_new_id:
1459
path = self._tree_id_paths[trans_id]
1460
inventory_delta.append((path, None, file_id, None))
1461
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1463
entries = self._tree.iter_entries_by_dir(
1464
new_path_file_ids.values())
1465
old_paths = dict((e.file_id, p) for p, e in entries)
1467
for num, (path, trans_id) in enumerate(new_paths):
1469
child_pb.update('adding file',
1470
num + len(self._removed_id), total_entries)
1471
file_id = new_path_file_ids[trans_id]
1476
kind = self.final_kind(trans_id)
1478
kind = self._tree.stored_kind(file_id)
1479
parent_trans_id = self.final_parent(trans_id)
1480
parent_file_id = new_path_file_ids.get(parent_trans_id)
1481
if parent_file_id is None:
1482
parent_file_id = self.final_file_id(parent_trans_id)
1483
if trans_id in self._new_reference_revision:
1484
new_entry = inventory.TreeReference(
1486
self._new_name[trans_id],
1487
self.final_file_id(self._new_parent[trans_id]),
1488
None, self._new_reference_revision[trans_id])
1490
new_entry = inventory.make_entry(kind,
1491
self.final_name(trans_id),
1492
parent_file_id, file_id)
1493
old_path = old_paths.get(new_entry.file_id)
1494
new_executability = self._new_executability.get(trans_id)
1495
if new_executability is not None:
1496
new_entry.executable = new_executability
1497
inventory_delta.append(
1498
(old_path, path, new_entry.file_id, new_entry))
1501
return inventory_delta
1503
def _apply_removals(self, mover):
1504
"""Perform tree operations that remove directory/inventory names.
1506
That is, delete files that are to be deleted, and put any files that
1507
need renaming into limbo. This must be done in strict child-to-parent
1510
If inventory_delta is None, no inventory delta generation is performed.
1512
tree_paths = list(self._tree_path_ids.iteritems())
1513
tree_paths.sort(reverse=True)
1514
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1516
for num, data in enumerate(tree_paths):
1517
path, trans_id = data
1518
child_pb.update('removing file', num, len(tree_paths))
1519
full_path = self._tree.abspath(path)
1520
if trans_id in self._removed_contents:
1521
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1523
elif trans_id in self._new_name or trans_id in \
1526
mover.rename(full_path, self._limbo_name(trans_id))
1528
if e.errno != errno.ENOENT:
1531
self.rename_count += 1
1535
def _apply_insertions(self, mover):
1536
"""Perform tree operations that insert directory/inventory names.
1538
That is, create any files that need to be created, and restore from
1539
limbo any files that needed renaming. This must be done in strict
1540
parent-to-child order.
1542
If inventory_delta is None, no inventory delta is calculated, and
1543
no list of modified paths is returned.
1545
new_paths = self.new_paths(filesystem_only=True)
1547
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1549
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1551
for num, (path, trans_id) in enumerate(new_paths):
1553
child_pb.update('adding file', num, len(new_paths))
1554
full_path = self._tree.abspath(path)
1555
if trans_id in self._needs_rename:
1557
mover.rename(self._limbo_name(trans_id), full_path)
1559
# We may be renaming a dangling inventory id
1560
if e.errno != errno.ENOENT:
1563
self.rename_count += 1
1564
if (trans_id in self._new_contents or
1565
self.path_changed(trans_id)):
1566
if trans_id in self._new_contents:
1567
modified_paths.append(full_path)
1568
if trans_id in self._new_executability:
1569
self._set_executability(path, trans_id)
1572
self._new_contents.clear()
1573
return modified_paths
1576
class TransformPreview(DiskTreeTransform):
1577
"""A TreeTransform for generating preview trees.
1579
Unlike TreeTransform, this version works when the input tree is a
1580
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1581
unversioned files in the input tree.
1584
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1586
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1587
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1589
def canonical_path(self, path):
1592
def tree_kind(self, trans_id):
1593
path = self._tree_id_paths.get(trans_id)
1595
raise NoSuchFile(None)
1596
file_id = self._tree.path2id(path)
1597
return self._tree.kind(file_id)
1599
def _set_mode(self, trans_id, mode_id, typefunc):
1600
"""Set the mode of new file contents.
1601
The mode_id is the existing file to get the mode from (often the same
1602
as trans_id). The operation is only performed if there's a mode match
1603
according to typefunc.
1605
# is it ok to ignore this? probably
1608
def iter_tree_children(self, parent_id):
1609
"""Iterate through the entry's tree children, if any"""
1611
path = self._tree_id_paths[parent_id]
1614
file_id = self.tree_file_id(parent_id)
1617
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1618
children = getattr(entry, 'children', {})
1619
for child in children:
1620
childpath = joinpath(path, child)
1621
yield self.trans_id_tree_path(childpath)
1624
class _PreviewTree(tree.Tree):
1625
"""Partial implementation of Tree to support show_diff_trees"""
1627
def __init__(self, transform):
1628
self._transform = transform
1629
self._final_paths = FinalPaths(transform)
1630
self.__by_parent = None
1631
self._parent_ids = []
1632
self._all_children_cache = {}
1633
self._path2trans_id_cache = {}
1634
self._final_name_cache = {}
1636
def _changes(self, file_id):
1637
for changes in self._transform.iter_changes():
1638
if changes[0] == file_id:
1641
def _content_change(self, file_id):
1642
"""Return True if the content of this file changed"""
1643
changes = self._changes(file_id)
1644
# changes[2] is true if the file content changed. See
1645
# InterTree.iter_changes.
1646
return (changes is not None and changes[2])
1648
def _get_repository(self):
1649
repo = getattr(self._transform._tree, '_repository', None)
1651
repo = self._transform._tree.branch.repository
1654
def _iter_parent_trees(self):
1655
for revision_id in self.get_parent_ids():
1657
yield self.revision_tree(revision_id)
1658
except errors.NoSuchRevisionInTree:
1659
yield self._get_repository().revision_tree(revision_id)
1661
def _get_file_revision(self, file_id, vf, tree_revision):
1662
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1663
self._iter_parent_trees()]
1664
vf.add_lines((file_id, tree_revision), parent_keys,
1665
self.get_file(file_id).readlines())
1666
repo = self._get_repository()
1667
base_vf = repo.texts
1668
if base_vf not in vf.fallback_versionedfiles:
1669
vf.fallback_versionedfiles.append(base_vf)
1670
return tree_revision
1672
def _stat_limbo_file(self, file_id):
1673
trans_id = self._transform.trans_id_file_id(file_id)
1674
name = self._transform._limbo_name(trans_id)
1675
return os.lstat(name)
1678
def _by_parent(self):
1679
if self.__by_parent is None:
1680
self.__by_parent = self._transform.by_parent()
1681
return self.__by_parent
1683
def _comparison_data(self, entry, path):
1684
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1685
if kind == 'missing':
1689
file_id = self._transform.final_file_id(self._path2trans_id(path))
1690
executable = self.is_executable(file_id, path)
1691
return kind, executable, None
1693
def lock_read(self):
1694
# Perhaps in theory, this should lock the TreeTransform?
1701
def inventory(self):
1702
"""This Tree does not use inventory as its backing data."""
1703
raise NotImplementedError(_PreviewTree.inventory)
1705
def get_root_id(self):
1706
return self._transform.final_file_id(self._transform.root)
1708
def all_file_ids(self):
1709
tree_ids = set(self._transform._tree.all_file_ids())
1710
tree_ids.difference_update(self._transform.tree_file_id(t)
1711
for t in self._transform._removed_id)
1712
tree_ids.update(self._transform._new_id.values())
1716
return iter(self.all_file_ids())
1718
def has_id(self, file_id):
1719
if file_id in self._transform._r_new_id:
1721
elif file_id in set([self._transform.tree_file_id(trans_id) for
1722
trans_id in self._transform._removed_id]):
1725
return self._transform._tree.has_id(file_id)
1727
def _path2trans_id(self, path):
1728
# We must not use None here, because that is a valid value to store.
1729
trans_id = self._path2trans_id_cache.get(path, object)
1730
if trans_id is not object:
1732
segments = splitpath(path)
1733
cur_parent = self._transform.root
1734
for cur_segment in segments:
1735
for child in self._all_children(cur_parent):
1736
final_name = self._final_name_cache.get(child)
1737
if final_name is None:
1738
final_name = self._transform.final_name(child)
1739
self._final_name_cache[child] = final_name
1740
if final_name == cur_segment:
1744
self._path2trans_id_cache[path] = None
1746
self._path2trans_id_cache[path] = cur_parent
1749
def path2id(self, path):
1750
return self._transform.final_file_id(self._path2trans_id(path))
1752
def id2path(self, file_id):
1753
trans_id = self._transform.trans_id_file_id(file_id)
1755
return self._final_paths._determine_path(trans_id)
1757
raise errors.NoSuchId(self, file_id)
1759
def _all_children(self, trans_id):
1760
children = self._all_children_cache.get(trans_id)
1761
if children is not None:
1763
children = set(self._transform.iter_tree_children(trans_id))
1764
# children in the _new_parent set are provided by _by_parent.
1765
children.difference_update(self._transform._new_parent.keys())
1766
children.update(self._by_parent.get(trans_id, []))
1767
self._all_children_cache[trans_id] = children
1770
def iter_children(self, file_id):
1771
trans_id = self._transform.trans_id_file_id(file_id)
1772
for child_trans_id in self._all_children(trans_id):
1773
yield self._transform.final_file_id(child_trans_id)
1776
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1777
in self._transform._tree.extras())
1778
possible_extras.update(self._transform._new_contents)
1779
possible_extras.update(self._transform._removed_id)
1780
for trans_id in possible_extras:
1781
if self._transform.final_file_id(trans_id) is None:
1782
yield self._final_paths._determine_path(trans_id)
1784
def _make_inv_entries(self, ordered_entries, specific_file_ids=None):
1785
for trans_id, parent_file_id in ordered_entries:
1786
file_id = self._transform.final_file_id(trans_id)
1789
if (specific_file_ids is not None
1790
and file_id not in specific_file_ids):
1793
kind = self._transform.final_kind(trans_id)
1795
kind = self._transform._tree.stored_kind(file_id)
1796
new_entry = inventory.make_entry(
1798
self._transform.final_name(trans_id),
1799
parent_file_id, file_id)
1800
yield new_entry, trans_id
1802
def _list_files_by_dir(self):
1803
todo = [ROOT_PARENT]
1805
while len(todo) > 0:
1807
parent_file_id = self._transform.final_file_id(parent)
1808
children = list(self._all_children(parent))
1809
paths = dict(zip(children, self._final_paths.get_paths(children)))
1810
children.sort(key=paths.get)
1811
todo.extend(reversed(children))
1812
for trans_id in children:
1813
ordered_ids.append((trans_id, parent_file_id))
1816
def iter_entries_by_dir(self, specific_file_ids=None):
1817
# This may not be a maximally efficient implementation, but it is
1818
# reasonably straightforward. An implementation that grafts the
1819
# TreeTransform changes onto the tree's iter_entries_by_dir results
1820
# might be more efficient, but requires tricky inferences about stack
1822
ordered_ids = self._list_files_by_dir()
1823
for entry, trans_id in self._make_inv_entries(ordered_ids,
1825
yield unicode(self._final_paths.get_path(trans_id)), entry
1827
def _iter_entries_for_dir(self, dir_path):
1828
"""Return path, entry for items in a directory without recursing down."""
1829
dir_file_id = self.path2id(dir_path)
1831
for file_id in self.iter_children(dir_file_id):
1832
trans_id = self._transform.trans_id_file_id(file_id)
1833
ordered_ids.append((trans_id, file_id))
1834
for entry, trans_id in self._make_inv_entries(ordered_ids):
1835
yield unicode(self._final_paths.get_path(trans_id)), entry
1837
def list_files(self, include_root=False, from_dir=None, recursive=True):
1838
"""See WorkingTree.list_files."""
1839
# XXX This should behave like WorkingTree.list_files, but is really
1840
# more like RevisionTree.list_files.
1844
prefix = from_dir + '/'
1845
entries = self.iter_entries_by_dir()
1846
for path, entry in entries:
1847
if entry.name == '' and not include_root:
1850
if not path.startswith(prefix):
1852
path = path[len(prefix):]
1853
yield path, 'V', entry.kind, entry.file_id, entry
1855
if from_dir is None and include_root is True:
1856
root_entry = inventory.make_entry('directory', '',
1857
ROOT_PARENT, self.get_root_id())
1858
yield '', 'V', 'directory', root_entry.file_id, root_entry
1859
entries = self._iter_entries_for_dir(from_dir or '')
1860
for path, entry in entries:
1861
yield path, 'V', entry.kind, entry.file_id, entry
1863
def kind(self, file_id):
1864
trans_id = self._transform.trans_id_file_id(file_id)
1865
return self._transform.final_kind(trans_id)
1867
def stored_kind(self, file_id):
1868
trans_id = self._transform.trans_id_file_id(file_id)
1870
return self._transform._new_contents[trans_id]
1872
return self._transform._tree.stored_kind(file_id)
1874
def get_file_mtime(self, file_id, path=None):
1875
"""See Tree.get_file_mtime"""
1876
if not self._content_change(file_id):
1877
return self._transform._tree.get_file_mtime(file_id, path)
1878
return self._stat_limbo_file(file_id).st_mtime
1880
def _file_size(self, entry, stat_value):
1881
return self.get_file_size(entry.file_id)
1883
def get_file_size(self, file_id):
1884
"""See Tree.get_file_size"""
1885
if self.kind(file_id) == 'file':
1886
return self._transform._tree.get_file_size(file_id)
1890
def get_file_sha1(self, file_id, path=None, stat_value=None):
1891
trans_id = self._transform.trans_id_file_id(file_id)
1892
kind = self._transform._new_contents.get(trans_id)
1894
return self._transform._tree.get_file_sha1(file_id)
1896
fileobj = self.get_file(file_id)
1898
return sha_file(fileobj)
1902
def is_executable(self, file_id, path=None):
1905
trans_id = self._transform.trans_id_file_id(file_id)
1907
return self._transform._new_executability[trans_id]
1910
return self._transform._tree.is_executable(file_id, path)
1912
if e.errno == errno.ENOENT:
1915
except errors.NoSuchId:
1918
def path_content_summary(self, path):
1919
trans_id = self._path2trans_id(path)
1920
tt = self._transform
1921
tree_path = tt._tree_id_paths.get(trans_id)
1922
kind = tt._new_contents.get(trans_id)
1924
if tree_path is None or trans_id in tt._removed_contents:
1925
return 'missing', None, None, None
1926
summary = tt._tree.path_content_summary(tree_path)
1927
kind, size, executable, link_or_sha1 = summary
1930
limbo_name = tt._limbo_name(trans_id)
1931
if trans_id in tt._new_reference_revision:
1932
kind = 'tree-reference'
1934
statval = os.lstat(limbo_name)
1935
size = statval.st_size
1936
if not supports_executable():
1939
executable = statval.st_mode & S_IEXEC
1943
if kind == 'symlink':
1944
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1945
if supports_executable():
1946
executable = tt._new_executability.get(trans_id, executable)
1947
return kind, size, executable, link_or_sha1
1949
def iter_changes(self, from_tree, include_unchanged=False,
1950
specific_files=None, pb=None, extra_trees=None,
1951
require_versioned=True, want_unversioned=False):
1952
"""See InterTree.iter_changes.
1954
This has a fast path that is only used when the from_tree matches
1955
the transform tree, and no fancy options are supplied.
1957
if (from_tree is not self._transform._tree or include_unchanged or
1958
specific_files or want_unversioned):
1959
return tree.InterTree(from_tree, self).iter_changes(
1960
include_unchanged=include_unchanged,
1961
specific_files=specific_files,
1963
extra_trees=extra_trees,
1964
require_versioned=require_versioned,
1965
want_unversioned=want_unversioned)
1966
if want_unversioned:
1967
raise ValueError('want_unversioned is not supported')
1968
return self._transform.iter_changes()
1970
def get_file(self, file_id, path=None):
1971
"""See Tree.get_file"""
1972
if not self._content_change(file_id):
1973
return self._transform._tree.get_file(file_id, path)
1974
trans_id = self._transform.trans_id_file_id(file_id)
1975
name = self._transform._limbo_name(trans_id)
1976
return open(name, 'rb')
1978
def get_file_with_stat(self, file_id, path=None):
1979
return self.get_file(file_id, path), None
1981
def annotate_iter(self, file_id,
1982
default_revision=_mod_revision.CURRENT_REVISION):
1983
changes = self._changes(file_id)
1987
changed_content, versioned, kind = (changes[2], changes[3],
1991
get_old = (kind[0] == 'file' and versioned[0])
1993
old_annotation = self._transform._tree.annotate_iter(file_id,
1994
default_revision=default_revision)
1998
return old_annotation
1999
if not changed_content:
2000
return old_annotation
2001
# TODO: This is doing something similar to what WT.annotate_iter is
2002
# doing, however it fails slightly because it doesn't know what
2003
# the *other* revision_id is, so it doesn't know how to give the
2004
# other as the origin for some lines, they all get
2005
# 'default_revision'
2006
# It would be nice to be able to use the new Annotator based
2007
# approach, as well.
2008
return annotate.reannotate([old_annotation],
2009
self.get_file(file_id).readlines(),
2012
def get_symlink_target(self, file_id):
2013
"""See Tree.get_symlink_target"""
2014
if not self._content_change(file_id):
2015
return self._transform._tree.get_symlink_target(file_id)
2016
trans_id = self._transform.trans_id_file_id(file_id)
2017
name = self._transform._limbo_name(trans_id)
2018
return osutils.readlink(name)
2020
def walkdirs(self, prefix=''):
2021
pending = [self._transform.root]
2022
while len(pending) > 0:
2023
parent_id = pending.pop()
2026
prefix = prefix.rstrip('/')
2027
parent_path = self._final_paths.get_path(parent_id)
2028
parent_file_id = self._transform.final_file_id(parent_id)
2029
for child_id in self._all_children(parent_id):
2030
path_from_root = self._final_paths.get_path(child_id)
2031
basename = self._transform.final_name(child_id)
2032
file_id = self._transform.final_file_id(child_id)
2034
kind = self._transform.final_kind(child_id)
2035
versioned_kind = kind
2038
versioned_kind = self._transform._tree.stored_kind(file_id)
2039
if versioned_kind == 'directory':
2040
subdirs.append(child_id)
2041
children.append((path_from_root, basename, kind, None,
2042
file_id, versioned_kind))
2044
if parent_path.startswith(prefix):
2045
yield (parent_path, parent_file_id), children
2046
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2049
def get_parent_ids(self):
2050
return self._parent_ids
2052
def set_parent_ids(self, parent_ids):
2053
self._parent_ids = parent_ids
2055
def get_revision_tree(self, revision_id):
2056
return self._transform._tree.get_revision_tree(revision_id)
2059
def joinpath(parent, child):
2060
"""Join tree-relative paths, handling the tree root specially"""
2061
if parent is None or parent == "":
2064
return pathjoin(parent, child)
2067
class FinalPaths(object):
2068
"""Make path calculation cheap by memoizing paths.
2070
The underlying tree must not be manipulated between calls, or else
2071
the results will likely be incorrect.
2073
def __init__(self, transform):
2074
object.__init__(self)
2075
self._known_paths = {}
2076
self.transform = transform
2078
def _determine_path(self, trans_id):
2079
if trans_id == self.transform.root:
2081
name = self.transform.final_name(trans_id)
2082
parent_id = self.transform.final_parent(trans_id)
2083
if parent_id == self.transform.root:
2086
return pathjoin(self.get_path(parent_id), name)
2088
def get_path(self, trans_id):
2089
"""Find the final path associated with a trans_id"""
2090
if trans_id not in self._known_paths:
2091
self._known_paths[trans_id] = self._determine_path(trans_id)
2092
return self._known_paths[trans_id]
2094
def get_paths(self, trans_ids):
2095
return [(self.get_path(t), t) for t in trans_ids]
2099
def topology_sorted_ids(tree):
2100
"""Determine the topological order of the ids in a tree"""
2101
file_ids = list(tree)
2102
file_ids.sort(key=tree.id2path)
2106
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2107
delta_from_tree=False):
2108
"""Create working tree for a branch, using a TreeTransform.
2110
This function should be used on empty trees, having a tree root at most.
2111
(see merge and revert functionality for working with existing trees)
2113
Existing files are handled like so:
2115
- Existing bzrdirs take precedence over creating new items. They are
2116
created as '%s.diverted' % name.
2117
- Otherwise, if the content on disk matches the content we are building,
2118
it is silently replaced.
2119
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2121
:param tree: The tree to convert wt into a copy of
2122
:param wt: The working tree that files will be placed into
2123
:param accelerator_tree: A tree which can be used for retrieving file
2124
contents more quickly than tree itself, i.e. a workingtree. tree
2125
will be used for cases where accelerator_tree's content is different.
2126
:param hardlink: If true, hard-link files to accelerator_tree, where
2127
possible. accelerator_tree must implement abspath, i.e. be a
2129
:param delta_from_tree: If true, build_tree may use the input Tree to
2130
generate the inventory delta.
2132
wt.lock_tree_write()
2136
if accelerator_tree is not None:
2137
accelerator_tree.lock_read()
2139
return _build_tree(tree, wt, accelerator_tree, hardlink,
2142
if accelerator_tree is not None:
2143
accelerator_tree.unlock()
2150
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2151
"""See build_tree."""
2152
for num, _unused in enumerate(wt.all_file_ids()):
2153
if num > 0: # more than just a root
2154
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2155
existing_files = set()
2156
for dir, files in wt.walkdirs():
2157
existing_files.update(f[0] for f in files)
2159
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2160
pp = ProgressPhase("Build phase", 2, top_pb)
2161
if tree.inventory.root is not None:
2162
# This is kind of a hack: we should be altering the root
2163
# as part of the regular tree shape diff logic.
2164
# The conditional test here is to avoid doing an
2165
# expensive operation (flush) every time the root id
2166
# is set within the tree, nor setting the root and thus
2167
# marking the tree as dirty, because we use two different
2168
# idioms here: tree interfaces and inventory interfaces.
2169
if wt.get_root_id() != tree.get_root_id():
2170
wt.set_root_id(tree.get_root_id())
2172
tt = TreeTransform(wt)
2176
file_trans_id[wt.get_root_id()] = \
2177
tt.trans_id_tree_file_id(wt.get_root_id())
2178
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2180
deferred_contents = []
2182
total = len(tree.inventory)
2184
precomputed_delta = []
2186
precomputed_delta = None
2187
for num, (tree_path, entry) in \
2188
enumerate(tree.inventory.iter_entries_by_dir()):
2189
pb.update("Building tree", num - len(deferred_contents), total)
2190
if entry.parent_id is None:
2193
file_id = entry.file_id
2195
precomputed_delta.append((None, tree_path, file_id, entry))
2196
if tree_path in existing_files:
2197
target_path = wt.abspath(tree_path)
2198
kind = file_kind(target_path)
2199
if kind == "directory":
2201
bzrdir.BzrDir.open(target_path)
2202
except errors.NotBranchError:
2206
if (file_id not in divert and
2207
_content_match(tree, entry, file_id, kind,
2209
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2210
if kind == 'directory':
2212
parent_id = file_trans_id[entry.parent_id]
2213
if entry.kind == 'file':
2214
# We *almost* replicate new_by_entry, so that we can defer
2215
# getting the file text, and get them all at once.
2216
trans_id = tt.create_path(entry.name, parent_id)
2217
file_trans_id[file_id] = trans_id
2218
tt.version_file(file_id, trans_id)
2219
executable = tree.is_executable(file_id, tree_path)
2221
tt.set_executability(executable, trans_id)
2222
trans_data = (trans_id, tree_path)
2223
deferred_contents.append((file_id, trans_data))
2225
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2228
new_trans_id = file_trans_id[file_id]
2229
old_parent = tt.trans_id_tree_path(tree_path)
2230
_reparent_children(tt, old_parent, new_trans_id)
2231
offset = num + 1 - len(deferred_contents)
2232
_create_files(tt, tree, deferred_contents, pb, offset,
2233
accelerator_tree, hardlink)
2237
divert_trans = set(file_trans_id[f] for f in divert)
2238
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2239
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2240
if len(raw_conflicts) > 0:
2241
precomputed_delta = None
2242
conflicts = cook_conflicts(raw_conflicts, tt)
2243
for conflict in conflicts:
2246
wt.add_conflicts(conflicts)
2247
except errors.UnsupportedOperation:
2249
result = tt.apply(no_conflicts=True,
2250
precomputed_delta=precomputed_delta)
2257
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2259
total = len(desired_files) + offset
2261
if accelerator_tree is None:
2262
new_desired_files = desired_files
2264
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2265
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2266
in iter if not (c or e[0] != e[1]))
2267
new_desired_files = []
2269
for file_id, (trans_id, tree_path) in desired_files:
2270
accelerator_path = unchanged.get(file_id)
2271
if accelerator_path is None:
2272
new_desired_files.append((file_id, (trans_id, tree_path)))
2274
pb.update('Adding file contents', count + offset, total)
2276
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2279
contents = accelerator_tree.get_file(file_id, accelerator_path)
2280
if wt.supports_content_filtering():
2281
filters = wt._content_filter_stack(tree_path)
2282
contents = filtered_output_bytes(contents, filters,
2283
ContentFilterContext(tree_path, tree))
2285
tt.create_file(contents, trans_id)
2289
except AttributeError:
2290
# after filtering, contents may no longer be file-like
2294
for count, ((trans_id, tree_path), contents) in enumerate(
2295
tree.iter_files_bytes(new_desired_files)):
2296
if wt.supports_content_filtering():
2297
filters = wt._content_filter_stack(tree_path)
2298
contents = filtered_output_bytes(contents, filters,
2299
ContentFilterContext(tree_path, tree))
2300
tt.create_file(contents, trans_id)
2301
pb.update('Adding file contents', count + offset, total)
2304
def _reparent_children(tt, old_parent, new_parent):
2305
for child in tt.iter_tree_children(old_parent):
2306
tt.adjust_path(tt.final_name(child), new_parent, child)
2308
def _reparent_transform_children(tt, old_parent, new_parent):
2309
by_parent = tt.by_parent()
2310
for child in by_parent[old_parent]:
2311
tt.adjust_path(tt.final_name(child), new_parent, child)
2312
return by_parent[old_parent]
2314
def _content_match(tree, entry, file_id, kind, target_path):
2315
if entry.kind != kind:
2317
if entry.kind == "directory":
2319
if entry.kind == "file":
2320
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2322
elif entry.kind == "symlink":
2323
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2328
def resolve_checkout(tt, conflicts, divert):
2329
new_conflicts = set()
2330
for c_type, conflict in ((c[0], c) for c in conflicts):
2331
# Anything but a 'duplicate' would indicate programmer error
2332
if c_type != 'duplicate':
2333
raise AssertionError(c_type)
2334
# Now figure out which is new and which is old
2335
if tt.new_contents(conflict[1]):
2336
new_file = conflict[1]
2337
old_file = conflict[2]
2339
new_file = conflict[2]
2340
old_file = conflict[1]
2342
# We should only get here if the conflict wasn't completely
2344
final_parent = tt.final_parent(old_file)
2345
if new_file in divert:
2346
new_name = tt.final_name(old_file)+'.diverted'
2347
tt.adjust_path(new_name, final_parent, new_file)
2348
new_conflicts.add((c_type, 'Diverted to',
2349
new_file, old_file))
2351
new_name = tt.final_name(old_file)+'.moved'
2352
tt.adjust_path(new_name, final_parent, old_file)
2353
new_conflicts.add((c_type, 'Moved existing file to',
2354
old_file, new_file))
2355
return new_conflicts
2358
def new_by_entry(tt, entry, parent_id, tree):
2359
"""Create a new file according to its inventory entry"""
2363
contents = tree.get_file(entry.file_id).readlines()
2364
executable = tree.is_executable(entry.file_id)
2365
return tt.new_file(name, parent_id, contents, entry.file_id,
2367
elif kind in ('directory', 'tree-reference'):
2368
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2369
if kind == 'tree-reference':
2370
tt.set_tree_reference(entry.reference_revision, trans_id)
2372
elif kind == 'symlink':
2373
target = tree.get_symlink_target(entry.file_id)
2374
return tt.new_symlink(name, parent_id, target, entry.file_id)
2376
raise errors.BadFileKindError(name, kind)
2379
@deprecated_function(deprecated_in((1, 9, 0)))
2380
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2381
"""Create new file contents according to an inventory entry.
2383
DEPRECATED. Use create_from_tree instead.
2385
if entry.kind == "file":
2387
lines = tree.get_file(entry.file_id).readlines()
2388
tt.create_file(lines, trans_id, mode_id=mode_id)
2389
elif entry.kind == "symlink":
2390
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2391
elif entry.kind == "directory":
2392
tt.create_directory(trans_id)
2395
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2396
"""Create new file contents according to tree contents."""
2397
kind = tree.kind(file_id)
2398
if kind == 'directory':
2399
tt.create_directory(trans_id)
2400
elif kind == "file":
2402
tree_file = tree.get_file(file_id)
2404
bytes = tree_file.readlines()
2407
tt.create_file(bytes, trans_id)
2408
elif kind == "symlink":
2409
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2411
raise AssertionError('Unknown kind %r' % kind)
2414
def create_entry_executability(tt, entry, trans_id):
2415
"""Set the executability of a trans_id according to an inventory entry"""
2416
if entry.kind == "file":
2417
tt.set_executability(entry.executable, trans_id)
2420
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2421
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2424
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2425
"""Produce a backup-style name that appears to be available"""
2429
yield "%s.~%d~" % (name, counter)
2431
for new_name in name_gen():
2432
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2436
def _entry_changes(file_id, entry, working_tree):
2437
"""Determine in which ways the inventory entry has changed.
2439
Returns booleans: has_contents, content_mod, meta_mod
2440
has_contents means there are currently contents, but they differ
2441
contents_mod means contents need to be modified
2442
meta_mod means the metadata needs to be modified
2444
cur_entry = working_tree.inventory[file_id]
2446
working_kind = working_tree.kind(file_id)
2449
has_contents = False
2452
if has_contents is True:
2453
if entry.kind != working_kind:
2454
contents_mod, meta_mod = True, False
2456
cur_entry._read_tree_state(working_tree.id2path(file_id),
2458
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2459
cur_entry._forget_tree_state()
2460
return has_contents, contents_mod, meta_mod
2463
def revert(working_tree, target_tree, filenames, backups=False,
2464
pb=DummyProgress(), change_reporter=None):
2465
"""Revert a working tree's contents to those of a target tree."""
2466
target_tree.lock_read()
2467
tt = TreeTransform(working_tree, pb)
2469
pp = ProgressPhase("Revert phase", 3, pb)
2470
conflicts, merge_modified = _prepare_revert_transform(
2471
working_tree, target_tree, tt, filenames, backups, pp)
2473
change_reporter = delta._ChangeReporter(
2474
unversioned_filter=working_tree.is_ignored)
2475
delta.report_changes(tt.iter_changes(), change_reporter)
2476
for conflict in conflicts:
2480
working_tree.set_merge_modified(merge_modified)
2482
target_tree.unlock()
2488
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2489
backups, pp, basis_tree=None,
2490
merge_modified=None):
2492
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2494
if merge_modified is None:
2495
merge_modified = working_tree.merge_modified()
2496
merge_modified = _alter_files(working_tree, target_tree, tt,
2497
child_pb, filenames, backups,
2498
merge_modified, basis_tree)
2502
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2504
raw_conflicts = resolve_conflicts(tt, child_pb,
2505
lambda t, c: conflict_pass(t, c, target_tree))
2508
conflicts = cook_conflicts(raw_conflicts, tt)
2509
return conflicts, merge_modified
2512
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2513
backups, merge_modified, basis_tree=None):
2514
if basis_tree is not None:
2515
basis_tree.lock_read()
2516
change_list = target_tree.iter_changes(working_tree,
2517
specific_files=specific_files, pb=pb)
2518
if target_tree.get_root_id() is None:
2524
for id_num, (file_id, path, changed_content, versioned, parent, name,
2525
kind, executable) in enumerate(change_list):
2526
if skip_root and file_id[0] is not None and parent[0] is None:
2528
trans_id = tt.trans_id_file_id(file_id)
2531
keep_content = False
2532
if kind[0] == 'file' and (backups or kind[1] is None):
2533
wt_sha1 = working_tree.get_file_sha1(file_id)
2534
if merge_modified.get(file_id) != wt_sha1:
2535
# acquire the basis tree lazily to prevent the
2536
# expense of accessing it when it's not needed ?
2537
# (Guessing, RBC, 200702)
2538
if basis_tree is None:
2539
basis_tree = working_tree.basis_tree()
2540
basis_tree.lock_read()
2541
if file_id in basis_tree:
2542
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2544
elif kind[1] is None and not versioned[1]:
2546
if kind[0] is not None:
2547
if not keep_content:
2548
tt.delete_contents(trans_id)
2549
elif kind[1] is not None:
2550
parent_trans_id = tt.trans_id_file_id(parent[0])
2551
by_parent = tt.by_parent()
2552
backup_name = _get_backup_name(name[0], by_parent,
2553
parent_trans_id, tt)
2554
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2555
new_trans_id = tt.create_path(name[0], parent_trans_id)
2556
if versioned == (True, True):
2557
tt.unversion_file(trans_id)
2558
tt.version_file(file_id, new_trans_id)
2559
# New contents should have the same unix perms as old
2562
trans_id = new_trans_id
2563
if kind[1] in ('directory', 'tree-reference'):
2564
tt.create_directory(trans_id)
2565
if kind[1] == 'tree-reference':
2566
revision = target_tree.get_reference_revision(file_id,
2568
tt.set_tree_reference(revision, trans_id)
2569
elif kind[1] == 'symlink':
2570
tt.create_symlink(target_tree.get_symlink_target(file_id),
2572
elif kind[1] == 'file':
2573
deferred_files.append((file_id, (trans_id, mode_id)))
2574
if basis_tree is None:
2575
basis_tree = working_tree.basis_tree()
2576
basis_tree.lock_read()
2577
new_sha1 = target_tree.get_file_sha1(file_id)
2578
if (file_id in basis_tree and new_sha1 ==
2579
basis_tree.get_file_sha1(file_id)):
2580
if file_id in merge_modified:
2581
del merge_modified[file_id]
2583
merge_modified[file_id] = new_sha1
2585
# preserve the execute bit when backing up
2586
if keep_content and executable[0] == executable[1]:
2587
tt.set_executability(executable[1], trans_id)
2588
elif kind[1] is not None:
2589
raise AssertionError(kind[1])
2590
if versioned == (False, True):
2591
tt.version_file(file_id, trans_id)
2592
if versioned == (True, False):
2593
tt.unversion_file(trans_id)
2594
if (name[1] is not None and
2595
(name[0] != name[1] or parent[0] != parent[1])):
2596
if name[1] == '' and parent[1] is None:
2597
parent_trans = ROOT_PARENT
2599
parent_trans = tt.trans_id_file_id(parent[1])
2600
tt.adjust_path(name[1], parent_trans, trans_id)
2601
if executable[0] != executable[1] and kind[1] == "file":
2602
tt.set_executability(executable[1], trans_id)
2603
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2605
tt.create_file(bytes, trans_id, mode_id)
2607
if basis_tree is not None:
2609
return merge_modified
2612
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2613
"""Make many conflict-resolution attempts, but die if they fail"""
2614
if pass_func is None:
2615
pass_func = conflict_pass
2616
new_conflicts = set()
2619
pb.update('Resolution pass', n+1, 10)
2620
conflicts = tt.find_conflicts()
2621
if len(conflicts) == 0:
2622
return new_conflicts
2623
new_conflicts.update(pass_func(tt, conflicts))
2624
raise MalformedTransform(conflicts=conflicts)
2629
def conflict_pass(tt, conflicts, path_tree=None):
2630
"""Resolve some classes of conflicts.
2632
:param tt: The transform to resolve conflicts in
2633
:param conflicts: The conflicts to resolve
2634
:param path_tree: A Tree to get supplemental paths from
2636
new_conflicts = set()
2637
for c_type, conflict in ((c[0], c) for c in conflicts):
2638
if c_type == 'duplicate id':
2639
tt.unversion_file(conflict[1])
2640
new_conflicts.add((c_type, 'Unversioned existing file',
2641
conflict[1], conflict[2], ))
2642
elif c_type == 'duplicate':
2643
# files that were renamed take precedence
2644
final_parent = tt.final_parent(conflict[1])
2645
if tt.path_changed(conflict[1]):
2646
existing_file, new_file = conflict[2], conflict[1]
2648
existing_file, new_file = conflict[1], conflict[2]
2649
new_name = tt.final_name(existing_file)+'.moved'
2650
tt.adjust_path(new_name, final_parent, existing_file)
2651
new_conflicts.add((c_type, 'Moved existing file to',
2652
existing_file, new_file))
2653
elif c_type == 'parent loop':
2654
# break the loop by undoing one of the ops that caused the loop
2656
while not tt.path_changed(cur):
2657
cur = tt.final_parent(cur)
2658
new_conflicts.add((c_type, 'Cancelled move', cur,
2659
tt.final_parent(cur),))
2660
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2662
elif c_type == 'missing parent':
2663
trans_id = conflict[1]
2665
tt.cancel_deletion(trans_id)
2666
new_conflicts.add(('deleting parent', 'Not deleting',
2671
tt.final_name(trans_id)
2673
if path_tree is not None:
2674
file_id = tt.final_file_id(trans_id)
2676
file_id = tt.inactive_file_id(trans_id)
2677
entry = path_tree.inventory[file_id]
2678
# special-case the other tree root (move its
2679
# children to current root)
2680
if entry.parent_id is None:
2682
moved = _reparent_transform_children(
2683
tt, trans_id, tt.root)
2685
new_conflicts.add((c_type, 'Moved to root',
2688
parent_trans_id = tt.trans_id_file_id(
2690
tt.adjust_path(entry.name, parent_trans_id,
2693
tt.create_directory(trans_id)
2694
new_conflicts.add((c_type, 'Created directory', trans_id))
2695
elif c_type == 'unversioned parent':
2696
file_id = tt.inactive_file_id(conflict[1])
2697
# special-case the other tree root (move its children instead)
2698
if path_tree and file_id in path_tree:
2699
if path_tree.inventory[file_id].parent_id is None:
2701
tt.version_file(file_id, conflict[1])
2702
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2703
elif c_type == 'non-directory parent':
2704
parent_id = conflict[1]
2705
parent_parent = tt.final_parent(parent_id)
2706
parent_name = tt.final_name(parent_id)
2707
parent_file_id = tt.final_file_id(parent_id)
2708
new_parent_id = tt.new_directory(parent_name + '.new',
2709
parent_parent, parent_file_id)
2710
_reparent_transform_children(tt, parent_id, new_parent_id)
2711
if parent_file_id is not None:
2712
tt.unversion_file(parent_id)
2713
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2714
elif c_type == 'versioning no contents':
2715
tt.cancel_versioning(conflict[1])
2716
return new_conflicts
2719
def cook_conflicts(raw_conflicts, tt):
2720
"""Generate a list of cooked conflicts, sorted by file path"""
2721
from bzrlib.conflicts import Conflict
2722
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2723
return sorted(conflict_iter, key=Conflict.sort_key)
2726
def iter_cook_conflicts(raw_conflicts, tt):
2727
from bzrlib.conflicts import Conflict
2729
for conflict in raw_conflicts:
2730
c_type = conflict[0]
2731
action = conflict[1]
2732
modified_path = fp.get_path(conflict[2])
2733
modified_id = tt.final_file_id(conflict[2])
2734
if len(conflict) == 3:
2735
yield Conflict.factory(c_type, action=action, path=modified_path,
2736
file_id=modified_id)
2739
conflicting_path = fp.get_path(conflict[3])
2740
conflicting_id = tt.final_file_id(conflict[3])
2741
yield Conflict.factory(c_type, action=action, path=modified_path,
2742
file_id=modified_id,
2743
conflict_path=conflicting_path,
2744
conflict_file_id=conflicting_id)
2747
class _FileMover(object):
2748
"""Moves and deletes files for TreeTransform, tracking operations"""
2751
self.past_renames = []
2752
self.pending_deletions = []
2754
def rename(self, from_, to):
2755
"""Rename a file from one path to another. Functions like os.rename"""
2757
os.rename(from_, to)
2759
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2760
raise errors.FileExists(to, str(e))
2762
self.past_renames.append((from_, to))
2764
def pre_delete(self, from_, to):
2765
"""Rename a file out of the way and mark it for deletion.
2767
Unlike os.unlink, this works equally well for files and directories.
2768
:param from_: The current file path
2769
:param to: A temporary path for the file
2771
self.rename(from_, to)
2772
self.pending_deletions.append(to)
2775
"""Reverse all renames that have been performed"""
2776
for from_, to in reversed(self.past_renames):
2777
os.rename(to, from_)
2778
# after rollback, don't reuse _FileMover
2780
pending_deletions = None
2782
def apply_deletions(self):
2783
"""Apply all marked deletions"""
2784
for path in self.pending_deletions:
2786
# after apply_deletions, don't reuse _FileMover
2788
pending_deletions = None
added
removed
bzrlib/transform.py
