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 ProgressTask 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 _check_malformed(self):
446
conflicts = self.find_conflicts()
447
if len(conflicts) != 0:
448
raise MalformedTransform(conflicts=conflicts)
450
def _add_tree_children(self):
451
"""Add all the children of all active parents to the known paths.
453
Active parents are those which gain children, and those which are
454
removed. This is a necessary first step in detecting conflicts.
456
parents = self.by_parent().keys()
457
parents.extend([t for t in self._removed_contents if
458
self.tree_kind(t) == 'directory'])
459
for trans_id in self._removed_id:
460
file_id = self.tree_file_id(trans_id)
461
if file_id is not None:
462
if self._tree.inventory[file_id].kind == 'directory':
463
parents.append(trans_id)
464
elif self.tree_kind(trans_id) == 'directory':
465
parents.append(trans_id)
467
for parent_id in parents:
468
# ensure that all children are registered with the transaction
469
list(self.iter_tree_children(parent_id))
471
def has_named_child(self, by_parent, parent_id, name):
473
children = by_parent[parent_id]
476
for child in children:
477
if self.final_name(child) == name:
480
path = self._tree_id_paths[parent_id]
483
childpath = joinpath(path, name)
484
child_id = self._tree_path_ids.get(childpath)
486
return lexists(self._tree.abspath(childpath))
488
if self.final_parent(child_id) != parent_id:
490
if child_id in self._removed_contents:
491
# XXX What about dangling file-ids?
496
def _parent_loops(self):
497
"""No entry should be its own ancestor"""
499
for trans_id in self._new_parent:
502
while parent_id is not ROOT_PARENT:
505
parent_id = self.final_parent(parent_id)
508
if parent_id == trans_id:
509
conflicts.append(('parent loop', trans_id))
510
if parent_id in seen:
514
def _unversioned_parents(self, by_parent):
515
"""If parent directories are versioned, children must be versioned."""
517
for parent_id, children in by_parent.iteritems():
518
if parent_id is ROOT_PARENT:
520
if self.final_file_id(parent_id) is not None:
522
for child_id in children:
523
if self.final_file_id(child_id) is not None:
524
conflicts.append(('unversioned parent', parent_id))
528
def _improper_versioning(self):
529
"""Cannot version a file with no contents, or a bad type.
531
However, existing entries with no contents are okay.
534
for trans_id in self._new_id.iterkeys():
536
kind = self.final_kind(trans_id)
538
conflicts.append(('versioning no contents', trans_id))
540
if not InventoryEntry.versionable_kind(kind):
541
conflicts.append(('versioning bad kind', trans_id, kind))
544
def _executability_conflicts(self):
545
"""Check for bad executability changes.
547
Only versioned files may have their executability set, because
548
1. only versioned entries can have executability under windows
549
2. only files can be executable. (The execute bit on a directory
550
does not indicate searchability)
553
for trans_id in self._new_executability:
554
if self.final_file_id(trans_id) is None:
555
conflicts.append(('unversioned executability', trans_id))
558
non_file = self.final_kind(trans_id) != "file"
562
conflicts.append(('non-file executability', trans_id))
565
def _overwrite_conflicts(self):
566
"""Check for overwrites (not permitted on Win32)"""
568
for trans_id in self._new_contents:
570
self.tree_kind(trans_id)
573
if trans_id not in self._removed_contents:
574
conflicts.append(('overwrite', trans_id,
575
self.final_name(trans_id)))
578
def _duplicate_entries(self, by_parent):
579
"""No directory may have two entries with the same name."""
581
if (self._new_name, self._new_parent) == ({}, {}):
583
for children in by_parent.itervalues():
584
name_ids = [(self.final_name(t), t) for t in children]
585
if not self._case_sensitive_target:
586
name_ids = [(n.lower(), t) for n, t in name_ids]
590
for name, trans_id in name_ids:
592
kind = self.final_kind(trans_id)
595
file_id = self.final_file_id(trans_id)
596
if kind is None and file_id is None:
598
if name == last_name:
599
conflicts.append(('duplicate', last_trans_id, trans_id,
602
last_trans_id = trans_id
605
def _duplicate_ids(self):
606
"""Each inventory id may only be used once"""
608
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
610
all_ids = self._tree.all_file_ids()
611
active_tree_ids = all_ids.difference(removed_tree_ids)
612
for trans_id, file_id in self._new_id.iteritems():
613
if file_id in active_tree_ids:
614
old_trans_id = self.trans_id_tree_file_id(file_id)
615
conflicts.append(('duplicate id', old_trans_id, trans_id))
618
def _parent_type_conflicts(self, by_parent):
619
"""parents must have directory 'contents'."""
621
for parent_id, children in by_parent.iteritems():
622
if parent_id is ROOT_PARENT:
624
if not self._any_contents(children):
626
for child in children:
628
self.final_kind(child)
632
kind = self.final_kind(parent_id)
636
conflicts.append(('missing parent', parent_id))
637
elif kind != "directory":
638
conflicts.append(('non-directory parent', parent_id))
641
def _any_contents(self, trans_ids):
642
"""Return true if any of the trans_ids, will have contents."""
643
for trans_id in trans_ids:
645
kind = self.final_kind(trans_id)
651
def _set_executability(self, path, trans_id):
652
"""Set the executability of versioned files """
653
if supports_executable():
654
new_executability = self._new_executability[trans_id]
655
abspath = self._tree.abspath(path)
656
current_mode = os.stat(abspath).st_mode
657
if new_executability:
660
to_mode = current_mode | (0100 & ~umask)
661
# Enable x-bit for others only if they can read it.
662
if current_mode & 0004:
663
to_mode |= 0001 & ~umask
664
if current_mode & 0040:
665
to_mode |= 0010 & ~umask
667
to_mode = current_mode & ~0111
668
os.chmod(abspath, to_mode)
670
def _new_entry(self, name, parent_id, file_id):
671
"""Helper function to create a new filesystem entry."""
672
trans_id = self.create_path(name, parent_id)
673
if file_id is not None:
674
self.version_file(file_id, trans_id)
677
def new_file(self, name, parent_id, contents, file_id=None,
679
"""Convenience method to create files.
681
name is the name of the file to create.
682
parent_id is the transaction id of the parent directory of the file.
683
contents is an iterator of bytestrings, which will be used to produce
685
:param file_id: The inventory ID of the file, if it is to be versioned.
686
:param executable: Only valid when a file_id has been supplied.
688
trans_id = self._new_entry(name, parent_id, file_id)
689
# TODO: rather than scheduling a set_executable call,
690
# have create_file create the file with the right mode.
691
self.create_file(contents, trans_id)
692
if executable is not None:
693
self.set_executability(executable, trans_id)
696
def new_directory(self, name, parent_id, file_id=None):
697
"""Convenience method to create directories.
699
name is the name of the directory to create.
700
parent_id is the transaction id of the parent directory of the
702
file_id is the inventory ID of the directory, if it is to be versioned.
704
trans_id = self._new_entry(name, parent_id, file_id)
705
self.create_directory(trans_id)
708
def new_symlink(self, name, parent_id, target, file_id=None):
709
"""Convenience method to create symbolic link.
711
name is the name of the symlink to create.
712
parent_id is the transaction id of the parent directory of the symlink.
713
target is a bytestring of the target of the symlink.
714
file_id is the inventory ID of the file, if it is to be versioned.
716
trans_id = self._new_entry(name, parent_id, file_id)
717
self.create_symlink(target, trans_id)
720
def _affected_ids(self):
721
"""Return the set of transform ids affected by the transform"""
722
trans_ids = set(self._removed_id)
723
trans_ids.update(self._new_id.keys())
724
trans_ids.update(self._removed_contents)
725
trans_ids.update(self._new_contents.keys())
726
trans_ids.update(self._new_executability.keys())
727
trans_ids.update(self._new_name.keys())
728
trans_ids.update(self._new_parent.keys())
731
def _get_file_id_maps(self):
732
"""Return mapping of file_ids to trans_ids in the to and from states"""
733
trans_ids = self._affected_ids()
736
# Build up two dicts: trans_ids associated with file ids in the
737
# FROM state, vs the TO state.
738
for trans_id in trans_ids:
739
from_file_id = self.tree_file_id(trans_id)
740
if from_file_id is not None:
741
from_trans_ids[from_file_id] = trans_id
742
to_file_id = self.final_file_id(trans_id)
743
if to_file_id is not None:
744
to_trans_ids[to_file_id] = trans_id
745
return from_trans_ids, to_trans_ids
747
def _from_file_data(self, from_trans_id, from_versioned, file_id):
748
"""Get data about a file in the from (tree) state
750
Return a (name, parent, kind, executable) tuple
752
from_path = self._tree_id_paths.get(from_trans_id)
754
# get data from working tree if versioned
755
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
756
from_name = from_entry.name
757
from_parent = from_entry.parent_id
760
if from_path is None:
761
# File does not exist in FROM state
765
# File exists, but is not versioned. Have to use path-
767
from_name = os.path.basename(from_path)
768
tree_parent = self.get_tree_parent(from_trans_id)
769
from_parent = self.tree_file_id(tree_parent)
770
if from_path is not None:
771
from_kind, from_executable, from_stats = \
772
self._tree._comparison_data(from_entry, from_path)
775
from_executable = False
776
return from_name, from_parent, from_kind, from_executable
778
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
779
"""Get data about a file in the to (target) state
781
Return a (name, parent, kind, executable) tuple
783
to_name = self.final_name(to_trans_id)
785
to_kind = self.final_kind(to_trans_id)
788
to_parent = self.final_file_id(self.final_parent(to_trans_id))
789
if to_trans_id in self._new_executability:
790
to_executable = self._new_executability[to_trans_id]
791
elif to_trans_id == from_trans_id:
792
to_executable = from_executable
794
to_executable = False
795
return to_name, to_parent, to_kind, to_executable
797
def iter_changes(self):
798
"""Produce output in the same format as Tree.iter_changes.
800
Will produce nonsensical results if invoked while inventory/filesystem
801
conflicts (as reported by TreeTransform.find_conflicts()) are present.
803
This reads the Transform, but only reproduces changes involving a
804
file_id. Files that are not versioned in either of the FROM or TO
805
states are not reflected.
807
final_paths = FinalPaths(self)
808
from_trans_ids, to_trans_ids = self._get_file_id_maps()
810
# Now iterate through all active file_ids
811
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
813
from_trans_id = from_trans_ids.get(file_id)
814
# find file ids, and determine versioning state
815
if from_trans_id is None:
816
from_versioned = False
817
from_trans_id = to_trans_ids[file_id]
819
from_versioned = True
820
to_trans_id = to_trans_ids.get(file_id)
821
if to_trans_id is None:
823
to_trans_id = from_trans_id
827
from_name, from_parent, from_kind, from_executable = \
828
self._from_file_data(from_trans_id, from_versioned, file_id)
830
to_name, to_parent, to_kind, to_executable = \
831
self._to_file_data(to_trans_id, from_trans_id, from_executable)
833
if not from_versioned:
836
from_path = self._tree_id_paths.get(from_trans_id)
840
to_path = final_paths.get_path(to_trans_id)
841
if from_kind != to_kind:
843
elif to_kind in ('file', 'symlink') and (
844
to_trans_id != from_trans_id or
845
to_trans_id in self._new_contents):
847
if (not modified and from_versioned == to_versioned and
848
from_parent==to_parent and from_name == to_name and
849
from_executable == to_executable):
851
results.append((file_id, (from_path, to_path), modified,
852
(from_versioned, to_versioned),
853
(from_parent, to_parent),
854
(from_name, to_name),
855
(from_kind, to_kind),
856
(from_executable, to_executable)))
857
return iter(sorted(results, key=lambda x:x[1]))
859
def get_preview_tree(self):
860
"""Return a tree representing the result of the transform.
862
The tree is a snapshot, and altering the TreeTransform will invalidate
865
return _PreviewTree(self)
867
def commit(self, branch, message, merge_parents=None, strict=False):
868
"""Commit the result of this TreeTransform to a branch.
870
:param branch: The branch to commit to.
871
:param message: The message to attach to the commit.
872
:param merge_parents: Additional parents specified by pending merges.
873
:return: The revision_id of the revision committed.
875
self._check_malformed()
877
unversioned = set(self._new_contents).difference(set(self._new_id))
878
for trans_id in unversioned:
879
if self.final_file_id(trans_id) is None:
880
raise errors.StrictCommitFailed()
882
revno, last_rev_id = branch.last_revision_info()
883
if last_rev_id == _mod_revision.NULL_REVISION:
884
if merge_parents is not None:
885
raise ValueError('Cannot supply merge parents for first'
889
parent_ids = [last_rev_id]
890
if merge_parents is not None:
891
parent_ids.extend(merge_parents)
892
if self._tree.get_revision_id() != last_rev_id:
893
raise ValueError('TreeTransform not based on branch basis: %s' %
894
self._tree.get_revision_id())
895
builder = branch.get_commit_builder(parent_ids)
896
preview = self.get_preview_tree()
897
list(builder.record_iter_changes(preview, last_rev_id,
898
self.iter_changes()))
899
builder.finish_inventory()
900
revision_id = builder.commit(message)
901
branch.set_last_revision_info(revno + 1, revision_id)
904
def _text_parent(self, trans_id):
905
file_id = self.tree_file_id(trans_id)
907
if file_id is None or self._tree.kind(file_id) != 'file':
909
except errors.NoSuchFile:
913
def _get_parents_texts(self, trans_id):
914
"""Get texts for compression parents of this file."""
915
file_id = self._text_parent(trans_id)
918
return (self._tree.get_file_text(file_id),)
920
def _get_parents_lines(self, trans_id):
921
"""Get lines for compression parents of this file."""
922
file_id = self._text_parent(trans_id)
925
return (self._tree.get_file_lines(file_id),)
927
def serialize(self, serializer):
928
"""Serialize this TreeTransform.
930
:param serializer: A Serialiser like pack.ContainerSerializer.
932
new_name = dict((k, v.encode('utf-8')) for k, v in
933
self._new_name.items())
934
new_executability = dict((k, int(v)) for k, v in
935
self._new_executability.items())
936
tree_path_ids = dict((k.encode('utf-8'), v)
937
for k, v in self._tree_path_ids.items())
939
'_id_number': self._id_number,
940
'_new_name': new_name,
941
'_new_parent': self._new_parent,
942
'_new_executability': new_executability,
943
'_new_id': self._new_id,
944
'_tree_path_ids': tree_path_ids,
945
'_removed_id': list(self._removed_id),
946
'_removed_contents': list(self._removed_contents),
947
'_non_present_ids': self._non_present_ids,
949
yield serializer.bytes_record(bencode.bencode(attribs),
951
for trans_id, kind in self._new_contents.items():
953
lines = osutils.chunks_to_lines(
954
self._read_file_chunks(trans_id))
955
parents = self._get_parents_lines(trans_id)
956
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
957
content = ''.join(mpdiff.to_patch())
958
if kind == 'directory':
960
if kind == 'symlink':
961
content = self._read_symlink_target(trans_id)
962
yield serializer.bytes_record(content, ((trans_id, kind),))
964
def deserialize(self, records):
965
"""Deserialize a stored TreeTransform.
967
:param records: An iterable of (names, content) tuples, as per
968
pack.ContainerPushParser.
970
names, content = records.next()
971
attribs = bencode.bdecode(content)
972
self._id_number = attribs['_id_number']
973
self._new_name = dict((k, v.decode('utf-8'))
974
for k, v in attribs['_new_name'].items())
975
self._new_parent = attribs['_new_parent']
976
self._new_executability = dict((k, bool(v)) for k, v in
977
attribs['_new_executability'].items())
978
self._new_id = attribs['_new_id']
979
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
980
self._tree_path_ids = {}
981
self._tree_id_paths = {}
982
for bytepath, trans_id in attribs['_tree_path_ids'].items():
983
path = bytepath.decode('utf-8')
984
self._tree_path_ids[path] = trans_id
985
self._tree_id_paths[trans_id] = path
986
self._removed_id = set(attribs['_removed_id'])
987
self._removed_contents = set(attribs['_removed_contents'])
988
self._non_present_ids = attribs['_non_present_ids']
989
for ((trans_id, kind),), content in records:
991
mpdiff = multiparent.MultiParent.from_patch(content)
992
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
993
self.create_file(lines, trans_id)
994
if kind == 'directory':
995
self.create_directory(trans_id)
996
if kind == 'symlink':
997
self.create_symlink(content.decode('utf-8'), trans_id)
1000
class DiskTreeTransform(TreeTransformBase):
1001
"""Tree transform storing its contents on disk."""
1003
def __init__(self, tree, limbodir, pb=DummyProgress(),
1004
case_sensitive=True):
1006
:param tree: The tree that will be transformed, but not necessarily
1008
:param limbodir: A directory where new files can be stored until
1009
they are installed in their proper places
1010
:param pb: A ProgressBar indicating how much progress is being made
1011
:param case_sensitive: If True, the target of the transform is
1012
case sensitive, not just case preserving.
1014
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1015
self._limbodir = limbodir
1016
self._deletiondir = None
1017
# A mapping of transform ids to their limbo filename
1018
self._limbo_files = {}
1019
# A mapping of transform ids to a set of the transform ids of children
1020
# that their limbo directory has
1021
self._limbo_children = {}
1022
# Map transform ids to maps of child filename to child transform id
1023
self._limbo_children_names = {}
1024
# List of transform ids that need to be renamed from limbo into place
1025
self._needs_rename = set()
1028
"""Release the working tree lock, if held, clean up limbo dir.
1030
This is required if apply has not been invoked, but can be invoked
1033
if self._tree is None:
1036
entries = [(self._limbo_name(t), t, k) for t, k in
1037
self._new_contents.iteritems()]
1038
entries.sort(reverse=True)
1039
for path, trans_id, kind in entries:
1042
delete_any(self._limbodir)
1044
# We don't especially care *why* the dir is immortal.
1045
raise ImmortalLimbo(self._limbodir)
1047
if self._deletiondir is not None:
1048
delete_any(self._deletiondir)
1050
raise errors.ImmortalPendingDeletion(self._deletiondir)
1052
TreeTransformBase.finalize(self)
1054
def _limbo_name(self, trans_id):
1055
"""Generate the limbo name of a file"""
1056
limbo_name = self._limbo_files.get(trans_id)
1057
if limbo_name is None:
1058
limbo_name = self._generate_limbo_path(trans_id)
1059
self._limbo_files[trans_id] = limbo_name
1062
def _generate_limbo_path(self, trans_id):
1063
"""Generate a limbo path using the trans_id as the relative path.
1065
This is suitable as a fallback, and when the transform should not be
1066
sensitive to the path encoding of the limbo directory.
1068
self._needs_rename.add(trans_id)
1069
return pathjoin(self._limbodir, trans_id)
1071
def adjust_path(self, name, parent, trans_id):
1072
previous_parent = self._new_parent.get(trans_id)
1073
previous_name = self._new_name.get(trans_id)
1074
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1075
if (trans_id in self._limbo_files and
1076
trans_id not in self._needs_rename):
1077
self._rename_in_limbo([trans_id])
1078
self._limbo_children[previous_parent].remove(trans_id)
1079
del self._limbo_children_names[previous_parent][previous_name]
1081
def _rename_in_limbo(self, trans_ids):
1082
"""Fix limbo names so that the right final path is produced.
1084
This means we outsmarted ourselves-- we tried to avoid renaming
1085
these files later by creating them with their final names in their
1086
final parents. But now the previous name or parent is no longer
1087
suitable, so we have to rename them.
1089
Even for trans_ids that have no new contents, we must remove their
1090
entries from _limbo_files, because they are now stale.
1092
for trans_id in trans_ids:
1093
old_path = self._limbo_files.pop(trans_id)
1094
if trans_id not in self._new_contents:
1096
new_path = self._limbo_name(trans_id)
1097
os.rename(old_path, new_path)
1098
for descendant in self._limbo_descendants(trans_id):
1099
desc_path = self._limbo_files[descendant]
1100
desc_path = new_path + desc_path[len(old_path):]
1101
self._limbo_files[descendant] = desc_path
1103
def _limbo_descendants(self, trans_id):
1104
"""Return the set of trans_ids whose limbo paths descend from this."""
1105
descendants = set(self._limbo_children.get(trans_id, []))
1106
for descendant in list(descendants):
1107
descendants.update(self._limbo_descendants(descendant))
1110
def create_file(self, contents, trans_id, mode_id=None):
1111
"""Schedule creation of a new file.
1115
Contents is an iterator of strings, all of which will be written
1116
to the target destination.
1118
New file takes the permissions of any existing file with that id,
1119
unless mode_id is specified.
1121
name = self._limbo_name(trans_id)
1122
f = open(name, 'wb')
1125
unique_add(self._new_contents, trans_id, 'file')
1127
# Clean up the file, it never got registered so
1128
# TreeTransform.finalize() won't clean it up.
1133
f.writelines(contents)
1136
self._set_mode(trans_id, mode_id, S_ISREG)
1138
def _read_file_chunks(self, trans_id):
1139
cur_file = open(self._limbo_name(trans_id), 'rb')
1141
return cur_file.readlines()
1145
def _read_symlink_target(self, trans_id):
1146
return os.readlink(self._limbo_name(trans_id))
1148
def create_hardlink(self, path, trans_id):
1149
"""Schedule creation of a hard link"""
1150
name = self._limbo_name(trans_id)
1154
if e.errno != errno.EPERM:
1156
raise errors.HardLinkNotSupported(path)
1158
unique_add(self._new_contents, trans_id, 'file')
1160
# Clean up the file, it never got registered so
1161
# TreeTransform.finalize() won't clean it up.
1165
def create_directory(self, trans_id):
1166
"""Schedule creation of a new directory.
1168
See also new_directory.
1170
os.mkdir(self._limbo_name(trans_id))
1171
unique_add(self._new_contents, trans_id, 'directory')
1173
def create_symlink(self, target, trans_id):
1174
"""Schedule creation of a new symbolic link.
1176
target is a bytestring.
1177
See also new_symlink.
1180
os.symlink(target, self._limbo_name(trans_id))
1181
unique_add(self._new_contents, trans_id, 'symlink')
1184
path = FinalPaths(self).get_path(trans_id)
1187
raise UnableCreateSymlink(path=path)
1189
def cancel_creation(self, trans_id):
1190
"""Cancel the creation of new file contents."""
1191
del self._new_contents[trans_id]
1192
children = self._limbo_children.get(trans_id)
1193
# if this is a limbo directory with children, move them before removing
1195
if children is not None:
1196
self._rename_in_limbo(children)
1197
del self._limbo_children[trans_id]
1198
del self._limbo_children_names[trans_id]
1199
delete_any(self._limbo_name(trans_id))
1202
class TreeTransform(DiskTreeTransform):
1203
"""Represent a tree transformation.
1205
This object is designed to support incremental generation of the transform,
1208
However, it gives optimum performance when parent directories are created
1209
before their contents. The transform is then able to put child files
1210
directly in their parent directory, avoiding later renames.
1212
It is easy to produce malformed transforms, but they are generally
1213
harmless. Attempting to apply a malformed transform will cause an
1214
exception to be raised before any modifications are made to the tree.
1216
Many kinds of malformed transforms can be corrected with the
1217
resolve_conflicts function. The remaining ones indicate programming error,
1218
such as trying to create a file with no path.
1220
Two sets of file creation methods are supplied. Convenience methods are:
1225
These are composed of the low-level methods:
1227
* create_file or create_directory or create_symlink
1231
Transform/Transaction ids
1232
-------------------------
1233
trans_ids are temporary ids assigned to all files involved in a transform.
1234
It's possible, even common, that not all files in the Tree have trans_ids.
1236
trans_ids are used because filenames and file_ids are not good enough
1237
identifiers; filenames change, and not all files have file_ids. File-ids
1238
are also associated with trans-ids, so that moving a file moves its
1241
trans_ids are only valid for the TreeTransform that generated them.
1245
Limbo is a temporary directory use to hold new versions of files.
1246
Files are added to limbo by create_file, create_directory, create_symlink,
1247
and their convenience variants (new_*). Files may be removed from limbo
1248
using cancel_creation. Files are renamed from limbo into their final
1249
location as part of TreeTransform.apply
1251
Limbo must be cleaned up, by either calling TreeTransform.apply or
1252
calling TreeTransform.finalize.
1254
Files are placed into limbo inside their parent directories, where
1255
possible. This reduces subsequent renames, and makes operations involving
1256
lots of files faster. This optimization is only possible if the parent
1257
directory is created *before* creating any of its children, so avoid
1258
creating children before parents, where possible.
1262
This temporary directory is used by _FileMover for storing files that are
1263
about to be deleted. In case of rollback, the files will be restored.
1264
FileMover does not delete files until it is sure that a rollback will not
1267
def __init__(self, tree, pb=DummyProgress()):
1268
"""Note: a tree_write lock is taken on the tree.
1270
Use TreeTransform.finalize() to release the lock (can be omitted if
1271
TreeTransform.apply() called).
1273
tree.lock_tree_write()
1276
limbodir = urlutils.local_path_from_url(
1277
tree._transport.abspath('limbo'))
1281
if e.errno == errno.EEXIST:
1282
raise ExistingLimbo(limbodir)
1283
deletiondir = urlutils.local_path_from_url(
1284
tree._transport.abspath('pending-deletion'))
1286
os.mkdir(deletiondir)
1288
if e.errno == errno.EEXIST:
1289
raise errors.ExistingPendingDeletion(deletiondir)
1294
# Cache of realpath results, to speed up canonical_path
1295
self._realpaths = {}
1296
# Cache of relpath results, to speed up canonical_path
1298
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1299
tree.case_sensitive)
1300
self._deletiondir = deletiondir
1302
def canonical_path(self, path):
1303
"""Get the canonical tree-relative path"""
1304
# don't follow final symlinks
1305
abs = self._tree.abspath(path)
1306
if abs in self._relpaths:
1307
return self._relpaths[abs]
1308
dirname, basename = os.path.split(abs)
1309
if dirname not in self._realpaths:
1310
self._realpaths[dirname] = os.path.realpath(dirname)
1311
dirname = self._realpaths[dirname]
1312
abs = pathjoin(dirname, basename)
1313
if dirname in self._relpaths:
1314
relpath = pathjoin(self._relpaths[dirname], basename)
1315
relpath = relpath.rstrip('/\\')
1317
relpath = self._tree.relpath(abs)
1318
self._relpaths[abs] = relpath
1321
def tree_kind(self, trans_id):
1322
"""Determine the file kind in the working tree.
1324
Raises NoSuchFile if the file does not exist
1326
path = self._tree_id_paths.get(trans_id)
1328
raise NoSuchFile(None)
1330
return file_kind(self._tree.abspath(path))
1332
if e.errno != errno.ENOENT:
1335
raise NoSuchFile(path)
1337
def _set_mode(self, trans_id, mode_id, typefunc):
1338
"""Set the mode of new file contents.
1339
The mode_id is the existing file to get the mode from (often the same
1340
as trans_id). The operation is only performed if there's a mode match
1341
according to typefunc.
1346
old_path = self._tree_id_paths[mode_id]
1350
mode = os.stat(self._tree.abspath(old_path)).st_mode
1352
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1353
# Either old_path doesn't exist, or the parent of the
1354
# target is not a directory (but will be one eventually)
1355
# Either way, we know it doesn't exist *right now*
1356
# See also bug #248448
1361
os.chmod(self._limbo_name(trans_id), mode)
1363
def iter_tree_children(self, parent_id):
1364
"""Iterate through the entry's tree children, if any"""
1366
path = self._tree_id_paths[parent_id]
1370
children = os.listdir(self._tree.abspath(path))
1372
if not (osutils._is_error_enotdir(e)
1373
or e.errno in (errno.ENOENT, errno.ESRCH)):
1377
for child in children:
1378
childpath = joinpath(path, child)
1379
if self._tree.is_control_filename(childpath):
1381
yield self.trans_id_tree_path(childpath)
1383
def _generate_limbo_path(self, trans_id):
1384
"""Generate a limbo path using the final path if possible.
1386
This optimizes the performance of applying the tree transform by
1387
avoiding renames. These renames can be avoided only when the parent
1388
directory is already scheduled for creation.
1390
If the final path cannot be used, falls back to using the trans_id as
1393
parent = self._new_parent.get(trans_id)
1394
# if the parent directory is already in limbo (e.g. when building a
1395
# tree), choose a limbo name inside the parent, to reduce further
1397
use_direct_path = False
1398
if self._new_contents.get(parent) == 'directory':
1399
filename = self._new_name.get(trans_id)
1400
if filename is not None:
1401
if parent not in self._limbo_children:
1402
self._limbo_children[parent] = set()
1403
self._limbo_children_names[parent] = {}
1404
use_direct_path = True
1405
# the direct path can only be used if no other file has
1406
# already taken this pathname, i.e. if the name is unused, or
1407
# if it is already associated with this trans_id.
1408
elif self._case_sensitive_target:
1409
if (self._limbo_children_names[parent].get(filename)
1410
in (trans_id, None)):
1411
use_direct_path = True
1413
for l_filename, l_trans_id in\
1414
self._limbo_children_names[parent].iteritems():
1415
if l_trans_id == trans_id:
1417
if l_filename.lower() == filename.lower():
1420
use_direct_path = True
1422
if not use_direct_path:
1423
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1425
limbo_name = pathjoin(self._limbo_files[parent], filename)
1426
self._limbo_children[parent].add(trans_id)
1427
self._limbo_children_names[parent][filename] = trans_id
1431
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1432
"""Apply all changes to the inventory and filesystem.
1434
If filesystem or inventory conflicts are present, MalformedTransform
1437
If apply succeeds, finalize is not necessary.
1439
:param no_conflicts: if True, the caller guarantees there are no
1440
conflicts, so no check is made.
1441
:param precomputed_delta: An inventory delta to use instead of
1443
:param _mover: Supply an alternate FileMover, for testing
1445
if not no_conflicts:
1446
self._check_malformed()
1447
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1449
if precomputed_delta is None:
1450
child_pb.update('Apply phase', 0, 2)
1451
inventory_delta = self._generate_inventory_delta()
1454
inventory_delta = precomputed_delta
1457
mover = _FileMover()
1461
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1462
self._apply_removals(mover)
1463
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1464
modified_paths = self._apply_insertions(mover)
1469
mover.apply_deletions()
1472
self._tree.apply_inventory_delta(inventory_delta)
1475
return _TransformResults(modified_paths, self.rename_count)
1477
def _generate_inventory_delta(self):
1478
"""Generate an inventory delta for the current transform."""
1479
inventory_delta = []
1480
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1481
new_paths = self._inventory_altered()
1482
total_entries = len(new_paths) + len(self._removed_id)
1484
for num, trans_id in enumerate(self._removed_id):
1486
child_pb.update('removing file', num, total_entries)
1487
if trans_id == self._new_root:
1488
file_id = self._tree.get_root_id()
1490
file_id = self.tree_file_id(trans_id)
1491
# File-id isn't really being deleted, just moved
1492
if file_id in self._r_new_id:
1494
path = self._tree_id_paths[trans_id]
1495
inventory_delta.append((path, None, file_id, None))
1496
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1498
entries = self._tree.iter_entries_by_dir(
1499
new_path_file_ids.values())
1500
old_paths = dict((e.file_id, p) for p, e in entries)
1502
for num, (path, trans_id) in enumerate(new_paths):
1504
child_pb.update('adding file',
1505
num + len(self._removed_id), total_entries)
1506
file_id = new_path_file_ids[trans_id]
1511
kind = self.final_kind(trans_id)
1513
kind = self._tree.stored_kind(file_id)
1514
parent_trans_id = self.final_parent(trans_id)
1515
parent_file_id = new_path_file_ids.get(parent_trans_id)
1516
if parent_file_id is None:
1517
parent_file_id = self.final_file_id(parent_trans_id)
1518
if trans_id in self._new_reference_revision:
1519
new_entry = inventory.TreeReference(
1521
self._new_name[trans_id],
1522
self.final_file_id(self._new_parent[trans_id]),
1523
None, self._new_reference_revision[trans_id])
1525
new_entry = inventory.make_entry(kind,
1526
self.final_name(trans_id),
1527
parent_file_id, file_id)
1528
old_path = old_paths.get(new_entry.file_id)
1529
new_executability = self._new_executability.get(trans_id)
1530
if new_executability is not None:
1531
new_entry.executable = new_executability
1532
inventory_delta.append(
1533
(old_path, path, new_entry.file_id, new_entry))
1536
return inventory_delta
1538
def _apply_removals(self, mover):
1539
"""Perform tree operations that remove directory/inventory names.
1541
That is, delete files that are to be deleted, and put any files that
1542
need renaming into limbo. This must be done in strict child-to-parent
1545
If inventory_delta is None, no inventory delta generation is performed.
1547
tree_paths = list(self._tree_path_ids.iteritems())
1548
tree_paths.sort(reverse=True)
1549
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1551
for num, data in enumerate(tree_paths):
1552
path, trans_id = data
1553
child_pb.update('removing file', num, len(tree_paths))
1554
full_path = self._tree.abspath(path)
1555
if trans_id in self._removed_contents:
1556
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1558
elif trans_id in self._new_name or trans_id in \
1561
mover.rename(full_path, self._limbo_name(trans_id))
1563
if e.errno != errno.ENOENT:
1566
self.rename_count += 1
1570
def _apply_insertions(self, mover):
1571
"""Perform tree operations that insert directory/inventory names.
1573
That is, create any files that need to be created, and restore from
1574
limbo any files that needed renaming. This must be done in strict
1575
parent-to-child order.
1577
If inventory_delta is None, no inventory delta is calculated, and
1578
no list of modified paths is returned.
1580
new_paths = self.new_paths(filesystem_only=True)
1582
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1584
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1586
for num, (path, trans_id) in enumerate(new_paths):
1588
child_pb.update('adding file', num, len(new_paths))
1589
full_path = self._tree.abspath(path)
1590
if trans_id in self._needs_rename:
1592
mover.rename(self._limbo_name(trans_id), full_path)
1594
# We may be renaming a dangling inventory id
1595
if e.errno != errno.ENOENT:
1598
self.rename_count += 1
1599
if (trans_id in self._new_contents or
1600
self.path_changed(trans_id)):
1601
if trans_id in self._new_contents:
1602
modified_paths.append(full_path)
1603
if trans_id in self._new_executability:
1604
self._set_executability(path, trans_id)
1607
self._new_contents.clear()
1608
return modified_paths
1611
class TransformPreview(DiskTreeTransform):
1612
"""A TreeTransform for generating preview trees.
1614
Unlike TreeTransform, this version works when the input tree is a
1615
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1616
unversioned files in the input tree.
1619
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1621
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1622
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1624
def canonical_path(self, path):
1627
def tree_kind(self, trans_id):
1628
path = self._tree_id_paths.get(trans_id)
1630
raise NoSuchFile(None)
1631
file_id = self._tree.path2id(path)
1632
return self._tree.kind(file_id)
1634
def _set_mode(self, trans_id, mode_id, typefunc):
1635
"""Set the mode of new file contents.
1636
The mode_id is the existing file to get the mode from (often the same
1637
as trans_id). The operation is only performed if there's a mode match
1638
according to typefunc.
1640
# is it ok to ignore this? probably
1643
def iter_tree_children(self, parent_id):
1644
"""Iterate through the entry's tree children, if any"""
1646
path = self._tree_id_paths[parent_id]
1649
file_id = self.tree_file_id(parent_id)
1652
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1653
children = getattr(entry, 'children', {})
1654
for child in children:
1655
childpath = joinpath(path, child)
1656
yield self.trans_id_tree_path(childpath)
1659
class _PreviewTree(tree.Tree):
1660
"""Partial implementation of Tree to support show_diff_trees"""
1662
def __init__(self, transform):
1663
self._transform = transform
1664
self._final_paths = FinalPaths(transform)
1665
self.__by_parent = None
1666
self._parent_ids = []
1667
self._all_children_cache = {}
1668
self._path2trans_id_cache = {}
1669
self._final_name_cache = {}
1670
self._iter_changes_cache = dict((c[0], c) for c in
1671
self._transform.iter_changes())
1673
def _content_change(self, file_id):
1674
"""Return True if the content of this file changed"""
1675
changes = self._iter_changes_cache.get(file_id)
1676
# changes[2] is true if the file content changed. See
1677
# InterTree.iter_changes.
1678
return (changes is not None and changes[2])
1680
def _get_repository(self):
1681
repo = getattr(self._transform._tree, '_repository', None)
1683
repo = self._transform._tree.branch.repository
1686
def _iter_parent_trees(self):
1687
for revision_id in self.get_parent_ids():
1689
yield self.revision_tree(revision_id)
1690
except errors.NoSuchRevisionInTree:
1691
yield self._get_repository().revision_tree(revision_id)
1693
def _get_file_revision(self, file_id, vf, tree_revision):
1694
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1695
self._iter_parent_trees()]
1696
vf.add_lines((file_id, tree_revision), parent_keys,
1697
self.get_file(file_id).readlines())
1698
repo = self._get_repository()
1699
base_vf = repo.texts
1700
if base_vf not in vf.fallback_versionedfiles:
1701
vf.fallback_versionedfiles.append(base_vf)
1702
return tree_revision
1704
def _stat_limbo_file(self, file_id):
1705
trans_id = self._transform.trans_id_file_id(file_id)
1706
name = self._transform._limbo_name(trans_id)
1707
return os.lstat(name)
1710
def _by_parent(self):
1711
if self.__by_parent is None:
1712
self.__by_parent = self._transform.by_parent()
1713
return self.__by_parent
1715
def _comparison_data(self, entry, path):
1716
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1717
if kind == 'missing':
1721
file_id = self._transform.final_file_id(self._path2trans_id(path))
1722
executable = self.is_executable(file_id, path)
1723
return kind, executable, None
1725
def lock_read(self):
1726
# Perhaps in theory, this should lock the TreeTransform?
1733
def inventory(self):
1734
"""This Tree does not use inventory as its backing data."""
1735
raise NotImplementedError(_PreviewTree.inventory)
1737
def get_root_id(self):
1738
return self._transform.final_file_id(self._transform.root)
1740
def all_file_ids(self):
1741
tree_ids = set(self._transform._tree.all_file_ids())
1742
tree_ids.difference_update(self._transform.tree_file_id(t)
1743
for t in self._transform._removed_id)
1744
tree_ids.update(self._transform._new_id.values())
1748
return iter(self.all_file_ids())
1750
def _has_id(self, file_id, fallback_check):
1751
if file_id in self._transform._r_new_id:
1753
elif file_id in set([self._transform.tree_file_id(trans_id) for
1754
trans_id in self._transform._removed_id]):
1757
return fallback_check(file_id)
1759
def has_id(self, file_id):
1760
return self._has_id(file_id, self._transform._tree.has_id)
1762
def has_or_had_id(self, file_id):
1763
return self._has_id(file_id, self._transform._tree.has_or_had_id)
1765
def _path2trans_id(self, path):
1766
# We must not use None here, because that is a valid value to store.
1767
trans_id = self._path2trans_id_cache.get(path, object)
1768
if trans_id is not object:
1770
segments = splitpath(path)
1771
cur_parent = self._transform.root
1772
for cur_segment in segments:
1773
for child in self._all_children(cur_parent):
1774
final_name = self._final_name_cache.get(child)
1775
if final_name is None:
1776
final_name = self._transform.final_name(child)
1777
self._final_name_cache[child] = final_name
1778
if final_name == cur_segment:
1782
self._path2trans_id_cache[path] = None
1784
self._path2trans_id_cache[path] = cur_parent
1787
def path2id(self, path):
1788
return self._transform.final_file_id(self._path2trans_id(path))
1790
def id2path(self, file_id):
1791
trans_id = self._transform.trans_id_file_id(file_id)
1793
return self._final_paths._determine_path(trans_id)
1795
raise errors.NoSuchId(self, file_id)
1797
def _all_children(self, trans_id):
1798
children = self._all_children_cache.get(trans_id)
1799
if children is not None:
1801
children = set(self._transform.iter_tree_children(trans_id))
1802
# children in the _new_parent set are provided by _by_parent.
1803
children.difference_update(self._transform._new_parent.keys())
1804
children.update(self._by_parent.get(trans_id, []))
1805
self._all_children_cache[trans_id] = children
1808
def iter_children(self, file_id):
1809
trans_id = self._transform.trans_id_file_id(file_id)
1810
for child_trans_id in self._all_children(trans_id):
1811
yield self._transform.final_file_id(child_trans_id)
1814
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1815
in self._transform._tree.extras())
1816
possible_extras.update(self._transform._new_contents)
1817
possible_extras.update(self._transform._removed_id)
1818
for trans_id in possible_extras:
1819
if self._transform.final_file_id(trans_id) is None:
1820
yield self._final_paths._determine_path(trans_id)
1822
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1823
yield_parents=False):
1824
for trans_id, parent_file_id in ordered_entries:
1825
file_id = self._transform.final_file_id(trans_id)
1828
if (specific_file_ids is not None
1829
and file_id not in specific_file_ids):
1832
kind = self._transform.final_kind(trans_id)
1834
kind = self._transform._tree.stored_kind(file_id)
1835
new_entry = inventory.make_entry(
1837
self._transform.final_name(trans_id),
1838
parent_file_id, file_id)
1839
yield new_entry, trans_id
1841
def _list_files_by_dir(self):
1842
todo = [ROOT_PARENT]
1844
while len(todo) > 0:
1846
parent_file_id = self._transform.final_file_id(parent)
1847
children = list(self._all_children(parent))
1848
paths = dict(zip(children, self._final_paths.get_paths(children)))
1849
children.sort(key=paths.get)
1850
todo.extend(reversed(children))
1851
for trans_id in children:
1852
ordered_ids.append((trans_id, parent_file_id))
1855
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1856
# This may not be a maximally efficient implementation, but it is
1857
# reasonably straightforward. An implementation that grafts the
1858
# TreeTransform changes onto the tree's iter_entries_by_dir results
1859
# might be more efficient, but requires tricky inferences about stack
1861
ordered_ids = self._list_files_by_dir()
1862
for entry, trans_id in self._make_inv_entries(ordered_ids,
1863
specific_file_ids, yield_parents=yield_parents):
1864
yield unicode(self._final_paths.get_path(trans_id)), entry
1866
def _iter_entries_for_dir(self, dir_path):
1867
"""Return path, entry for items in a directory without recursing down."""
1868
dir_file_id = self.path2id(dir_path)
1870
for file_id in self.iter_children(dir_file_id):
1871
trans_id = self._transform.trans_id_file_id(file_id)
1872
ordered_ids.append((trans_id, file_id))
1873
for entry, trans_id in self._make_inv_entries(ordered_ids):
1874
yield unicode(self._final_paths.get_path(trans_id)), entry
1876
def list_files(self, include_root=False, from_dir=None, recursive=True):
1877
"""See WorkingTree.list_files."""
1878
# XXX This should behave like WorkingTree.list_files, but is really
1879
# more like RevisionTree.list_files.
1883
prefix = from_dir + '/'
1884
entries = self.iter_entries_by_dir()
1885
for path, entry in entries:
1886
if entry.name == '' and not include_root:
1889
if not path.startswith(prefix):
1891
path = path[len(prefix):]
1892
yield path, 'V', entry.kind, entry.file_id, entry
1894
if from_dir is None and include_root is True:
1895
root_entry = inventory.make_entry('directory', '',
1896
ROOT_PARENT, self.get_root_id())
1897
yield '', 'V', 'directory', root_entry.file_id, root_entry
1898
entries = self._iter_entries_for_dir(from_dir or '')
1899
for path, entry in entries:
1900
yield path, 'V', entry.kind, entry.file_id, entry
1902
def kind(self, file_id):
1903
trans_id = self._transform.trans_id_file_id(file_id)
1904
return self._transform.final_kind(trans_id)
1906
def stored_kind(self, file_id):
1907
trans_id = self._transform.trans_id_file_id(file_id)
1909
return self._transform._new_contents[trans_id]
1911
return self._transform._tree.stored_kind(file_id)
1913
def get_file_mtime(self, file_id, path=None):
1914
"""See Tree.get_file_mtime"""
1915
if not self._content_change(file_id):
1916
return self._transform._tree.get_file_mtime(file_id)
1917
return self._stat_limbo_file(file_id).st_mtime
1919
def _file_size(self, entry, stat_value):
1920
return self.get_file_size(entry.file_id)
1922
def get_file_size(self, file_id):
1923
"""See Tree.get_file_size"""
1924
if self.kind(file_id) == 'file':
1925
return self._transform._tree.get_file_size(file_id)
1929
def get_file_sha1(self, file_id, path=None, stat_value=None):
1930
trans_id = self._transform.trans_id_file_id(file_id)
1931
kind = self._transform._new_contents.get(trans_id)
1933
return self._transform._tree.get_file_sha1(file_id)
1935
fileobj = self.get_file(file_id)
1937
return sha_file(fileobj)
1941
def is_executable(self, file_id, path=None):
1944
trans_id = self._transform.trans_id_file_id(file_id)
1946
return self._transform._new_executability[trans_id]
1949
return self._transform._tree.is_executable(file_id, path)
1951
if e.errno == errno.ENOENT:
1954
except errors.NoSuchId:
1957
def path_content_summary(self, path):
1958
trans_id = self._path2trans_id(path)
1959
tt = self._transform
1960
tree_path = tt._tree_id_paths.get(trans_id)
1961
kind = tt._new_contents.get(trans_id)
1963
if tree_path is None or trans_id in tt._removed_contents:
1964
return 'missing', None, None, None
1965
summary = tt._tree.path_content_summary(tree_path)
1966
kind, size, executable, link_or_sha1 = summary
1969
limbo_name = tt._limbo_name(trans_id)
1970
if trans_id in tt._new_reference_revision:
1971
kind = 'tree-reference'
1973
statval = os.lstat(limbo_name)
1974
size = statval.st_size
1975
if not supports_executable():
1978
executable = statval.st_mode & S_IEXEC
1982
if kind == 'symlink':
1983
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1984
executable = tt._new_executability.get(trans_id, executable)
1985
return kind, size, executable, link_or_sha1
1987
def iter_changes(self, from_tree, include_unchanged=False,
1988
specific_files=None, pb=None, extra_trees=None,
1989
require_versioned=True, want_unversioned=False):
1990
"""See InterTree.iter_changes.
1992
This has a fast path that is only used when the from_tree matches
1993
the transform tree, and no fancy options are supplied.
1995
if (from_tree is not self._transform._tree or include_unchanged or
1996
specific_files or want_unversioned):
1997
return tree.InterTree(from_tree, self).iter_changes(
1998
include_unchanged=include_unchanged,
1999
specific_files=specific_files,
2001
extra_trees=extra_trees,
2002
require_versioned=require_versioned,
2003
want_unversioned=want_unversioned)
2004
if want_unversioned:
2005
raise ValueError('want_unversioned is not supported')
2006
return self._transform.iter_changes()
2008
def get_file(self, file_id, path=None):
2009
"""See Tree.get_file"""
2010
if not self._content_change(file_id):
2011
return self._transform._tree.get_file(file_id, path)
2012
trans_id = self._transform.trans_id_file_id(file_id)
2013
name = self._transform._limbo_name(trans_id)
2014
return open(name, 'rb')
2016
def get_file_with_stat(self, file_id, path=None):
2017
return self.get_file(file_id, path), None
2019
def annotate_iter(self, file_id,
2020
default_revision=_mod_revision.CURRENT_REVISION):
2021
changes = self._iter_changes_cache.get(file_id)
2025
changed_content, versioned, kind = (changes[2], changes[3],
2029
get_old = (kind[0] == 'file' and versioned[0])
2031
old_annotation = self._transform._tree.annotate_iter(file_id,
2032
default_revision=default_revision)
2036
return old_annotation
2037
if not changed_content:
2038
return old_annotation
2039
# TODO: This is doing something similar to what WT.annotate_iter is
2040
# doing, however it fails slightly because it doesn't know what
2041
# the *other* revision_id is, so it doesn't know how to give the
2042
# other as the origin for some lines, they all get
2043
# 'default_revision'
2044
# It would be nice to be able to use the new Annotator based
2045
# approach, as well.
2046
return annotate.reannotate([old_annotation],
2047
self.get_file(file_id).readlines(),
2050
def get_symlink_target(self, file_id):
2051
"""See Tree.get_symlink_target"""
2052
if not self._content_change(file_id):
2053
return self._transform._tree.get_symlink_target(file_id)
2054
trans_id = self._transform.trans_id_file_id(file_id)
2055
name = self._transform._limbo_name(trans_id)
2056
return osutils.readlink(name)
2058
def walkdirs(self, prefix=''):
2059
pending = [self._transform.root]
2060
while len(pending) > 0:
2061
parent_id = pending.pop()
2064
prefix = prefix.rstrip('/')
2065
parent_path = self._final_paths.get_path(parent_id)
2066
parent_file_id = self._transform.final_file_id(parent_id)
2067
for child_id in self._all_children(parent_id):
2068
path_from_root = self._final_paths.get_path(child_id)
2069
basename = self._transform.final_name(child_id)
2070
file_id = self._transform.final_file_id(child_id)
2072
kind = self._transform.final_kind(child_id)
2073
versioned_kind = kind
2076
versioned_kind = self._transform._tree.stored_kind(file_id)
2077
if versioned_kind == 'directory':
2078
subdirs.append(child_id)
2079
children.append((path_from_root, basename, kind, None,
2080
file_id, versioned_kind))
2082
if parent_path.startswith(prefix):
2083
yield (parent_path, parent_file_id), children
2084
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2087
def get_parent_ids(self):
2088
return self._parent_ids
2090
def set_parent_ids(self, parent_ids):
2091
self._parent_ids = parent_ids
2093
def get_revision_tree(self, revision_id):
2094
return self._transform._tree.get_revision_tree(revision_id)
2097
def joinpath(parent, child):
2098
"""Join tree-relative paths, handling the tree root specially"""
2099
if parent is None or parent == "":
2102
return pathjoin(parent, child)
2105
class FinalPaths(object):
2106
"""Make path calculation cheap by memoizing paths.
2108
The underlying tree must not be manipulated between calls, or else
2109
the results will likely be incorrect.
2111
def __init__(self, transform):
2112
object.__init__(self)
2113
self._known_paths = {}
2114
self.transform = transform
2116
def _determine_path(self, trans_id):
2117
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2119
name = self.transform.final_name(trans_id)
2120
parent_id = self.transform.final_parent(trans_id)
2121
if parent_id == self.transform.root:
2124
return pathjoin(self.get_path(parent_id), name)
2126
def get_path(self, trans_id):
2127
"""Find the final path associated with a trans_id"""
2128
if trans_id not in self._known_paths:
2129
self._known_paths[trans_id] = self._determine_path(trans_id)
2130
return self._known_paths[trans_id]
2132
def get_paths(self, trans_ids):
2133
return [(self.get_path(t), t) for t in trans_ids]
2137
def topology_sorted_ids(tree):
2138
"""Determine the topological order of the ids in a tree"""
2139
file_ids = list(tree)
2140
file_ids.sort(key=tree.id2path)
2144
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2145
delta_from_tree=False):
2146
"""Create working tree for a branch, using a TreeTransform.
2148
This function should be used on empty trees, having a tree root at most.
2149
(see merge and revert functionality for working with existing trees)
2151
Existing files are handled like so:
2153
- Existing bzrdirs take precedence over creating new items. They are
2154
created as '%s.diverted' % name.
2155
- Otherwise, if the content on disk matches the content we are building,
2156
it is silently replaced.
2157
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2159
:param tree: The tree to convert wt into a copy of
2160
:param wt: The working tree that files will be placed into
2161
:param accelerator_tree: A tree which can be used for retrieving file
2162
contents more quickly than tree itself, i.e. a workingtree. tree
2163
will be used for cases where accelerator_tree's content is different.
2164
:param hardlink: If true, hard-link files to accelerator_tree, where
2165
possible. accelerator_tree must implement abspath, i.e. be a
2167
:param delta_from_tree: If true, build_tree may use the input Tree to
2168
generate the inventory delta.
2170
wt.lock_tree_write()
2174
if accelerator_tree is not None:
2175
accelerator_tree.lock_read()
2177
return _build_tree(tree, wt, accelerator_tree, hardlink,
2180
if accelerator_tree is not None:
2181
accelerator_tree.unlock()
2188
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2189
"""See build_tree."""
2190
for num, _unused in enumerate(wt.all_file_ids()):
2191
if num > 0: # more than just a root
2192
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2193
existing_files = set()
2194
for dir, files in wt.walkdirs():
2195
existing_files.update(f[0] for f in files)
2197
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2198
pp = ProgressPhase("Build phase", 2, top_pb)
2199
if tree.inventory.root is not None:
2200
# This is kind of a hack: we should be altering the root
2201
# as part of the regular tree shape diff logic.
2202
# The conditional test here is to avoid doing an
2203
# expensive operation (flush) every time the root id
2204
# is set within the tree, nor setting the root and thus
2205
# marking the tree as dirty, because we use two different
2206
# idioms here: tree interfaces and inventory interfaces.
2207
if wt.get_root_id() != tree.get_root_id():
2208
wt.set_root_id(tree.get_root_id())
2210
tt = TreeTransform(wt)
2214
file_trans_id[wt.get_root_id()] = \
2215
tt.trans_id_tree_file_id(wt.get_root_id())
2216
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2218
deferred_contents = []
2220
total = len(tree.inventory)
2222
precomputed_delta = []
2224
precomputed_delta = None
2225
for num, (tree_path, entry) in \
2226
enumerate(tree.inventory.iter_entries_by_dir()):
2227
pb.update("Building tree", num - len(deferred_contents), total)
2228
if entry.parent_id is None:
2231
file_id = entry.file_id
2233
precomputed_delta.append((None, tree_path, file_id, entry))
2234
if tree_path in existing_files:
2235
target_path = wt.abspath(tree_path)
2236
kind = file_kind(target_path)
2237
if kind == "directory":
2239
bzrdir.BzrDir.open(target_path)
2240
except errors.NotBranchError:
2244
if (file_id not in divert and
2245
_content_match(tree, entry, file_id, kind,
2247
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2248
if kind == 'directory':
2250
parent_id = file_trans_id[entry.parent_id]
2251
if entry.kind == 'file':
2252
# We *almost* replicate new_by_entry, so that we can defer
2253
# getting the file text, and get them all at once.
2254
trans_id = tt.create_path(entry.name, parent_id)
2255
file_trans_id[file_id] = trans_id
2256
tt.version_file(file_id, trans_id)
2257
executable = tree.is_executable(file_id, tree_path)
2259
tt.set_executability(executable, trans_id)
2260
trans_data = (trans_id, tree_path)
2261
deferred_contents.append((file_id, trans_data))
2263
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2266
new_trans_id = file_trans_id[file_id]
2267
old_parent = tt.trans_id_tree_path(tree_path)
2268
_reparent_children(tt, old_parent, new_trans_id)
2269
offset = num + 1 - len(deferred_contents)
2270
_create_files(tt, tree, deferred_contents, pb, offset,
2271
accelerator_tree, hardlink)
2275
divert_trans = set(file_trans_id[f] for f in divert)
2276
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2277
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2278
if len(raw_conflicts) > 0:
2279
precomputed_delta = None
2280
conflicts = cook_conflicts(raw_conflicts, tt)
2281
for conflict in conflicts:
2284
wt.add_conflicts(conflicts)
2285
except errors.UnsupportedOperation:
2287
result = tt.apply(no_conflicts=True,
2288
precomputed_delta=precomputed_delta)
2295
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2297
total = len(desired_files) + offset
2299
if accelerator_tree is None:
2300
new_desired_files = desired_files
2302
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2303
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2304
in iter if not (c or e[0] != e[1])]
2305
if accelerator_tree.supports_content_filtering():
2306
unchanged = [(f, p) for (f, p) in unchanged
2307
if not accelerator_tree.iter_search_rules([p]).next()]
2308
unchanged = dict(unchanged)
2309
new_desired_files = []
2311
for file_id, (trans_id, tree_path) in desired_files:
2312
accelerator_path = unchanged.get(file_id)
2313
if accelerator_path is None:
2314
new_desired_files.append((file_id, (trans_id, tree_path)))
2316
pb.update('Adding file contents', count + offset, total)
2318
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2321
contents = accelerator_tree.get_file(file_id, accelerator_path)
2322
if wt.supports_content_filtering():
2323
filters = wt._content_filter_stack(tree_path)
2324
contents = filtered_output_bytes(contents, filters,
2325
ContentFilterContext(tree_path, tree))
2327
tt.create_file(contents, trans_id)
2331
except AttributeError:
2332
# after filtering, contents may no longer be file-like
2336
for count, ((trans_id, tree_path), contents) in enumerate(
2337
tree.iter_files_bytes(new_desired_files)):
2338
if wt.supports_content_filtering():
2339
filters = wt._content_filter_stack(tree_path)
2340
contents = filtered_output_bytes(contents, filters,
2341
ContentFilterContext(tree_path, tree))
2342
tt.create_file(contents, trans_id)
2343
pb.update('Adding file contents', count + offset, total)
2346
def _reparent_children(tt, old_parent, new_parent):
2347
for child in tt.iter_tree_children(old_parent):
2348
tt.adjust_path(tt.final_name(child), new_parent, child)
2350
def _reparent_transform_children(tt, old_parent, new_parent):
2351
by_parent = tt.by_parent()
2352
for child in by_parent[old_parent]:
2353
tt.adjust_path(tt.final_name(child), new_parent, child)
2354
return by_parent[old_parent]
2356
def _content_match(tree, entry, file_id, kind, target_path):
2357
if entry.kind != kind:
2359
if entry.kind == "directory":
2361
if entry.kind == "file":
2362
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2364
elif entry.kind == "symlink":
2365
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2370
def resolve_checkout(tt, conflicts, divert):
2371
new_conflicts = set()
2372
for c_type, conflict in ((c[0], c) for c in conflicts):
2373
# Anything but a 'duplicate' would indicate programmer error
2374
if c_type != 'duplicate':
2375
raise AssertionError(c_type)
2376
# Now figure out which is new and which is old
2377
if tt.new_contents(conflict[1]):
2378
new_file = conflict[1]
2379
old_file = conflict[2]
2381
new_file = conflict[2]
2382
old_file = conflict[1]
2384
# We should only get here if the conflict wasn't completely
2386
final_parent = tt.final_parent(old_file)
2387
if new_file in divert:
2388
new_name = tt.final_name(old_file)+'.diverted'
2389
tt.adjust_path(new_name, final_parent, new_file)
2390
new_conflicts.add((c_type, 'Diverted to',
2391
new_file, old_file))
2393
new_name = tt.final_name(old_file)+'.moved'
2394
tt.adjust_path(new_name, final_parent, old_file)
2395
new_conflicts.add((c_type, 'Moved existing file to',
2396
old_file, new_file))
2397
return new_conflicts
2400
def new_by_entry(tt, entry, parent_id, tree):
2401
"""Create a new file according to its inventory entry"""
2405
contents = tree.get_file(entry.file_id).readlines()
2406
executable = tree.is_executable(entry.file_id)
2407
return tt.new_file(name, parent_id, contents, entry.file_id,
2409
elif kind in ('directory', 'tree-reference'):
2410
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2411
if kind == 'tree-reference':
2412
tt.set_tree_reference(entry.reference_revision, trans_id)
2414
elif kind == 'symlink':
2415
target = tree.get_symlink_target(entry.file_id)
2416
return tt.new_symlink(name, parent_id, target, entry.file_id)
2418
raise errors.BadFileKindError(name, kind)
2421
@deprecated_function(deprecated_in((1, 9, 0)))
2422
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2423
"""Create new file contents according to an inventory entry.
2425
DEPRECATED. Use create_from_tree instead.
2427
if entry.kind == "file":
2429
lines = tree.get_file(entry.file_id).readlines()
2430
tt.create_file(lines, trans_id, mode_id=mode_id)
2431
elif entry.kind == "symlink":
2432
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2433
elif entry.kind == "directory":
2434
tt.create_directory(trans_id)
2437
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2438
filter_tree_path=None):
2439
"""Create new file contents according to tree contents.
2441
:param filter_tree_path: the tree path to use to lookup
2442
content filters to apply to the bytes output in the working tree.
2443
This only applies if the working tree supports content filtering.
2445
kind = tree.kind(file_id)
2446
if kind == 'directory':
2447
tt.create_directory(trans_id)
2448
elif kind == "file":
2450
tree_file = tree.get_file(file_id)
2452
bytes = tree_file.readlines()
2456
if wt.supports_content_filtering() and filter_tree_path is not None:
2457
filters = wt._content_filter_stack(filter_tree_path)
2458
bytes = filtered_output_bytes(bytes, filters,
2459
ContentFilterContext(filter_tree_path, tree))
2460
tt.create_file(bytes, trans_id)
2461
elif kind == "symlink":
2462
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2464
raise AssertionError('Unknown kind %r' % kind)
2467
def create_entry_executability(tt, entry, trans_id):
2468
"""Set the executability of a trans_id according to an inventory entry"""
2469
if entry.kind == "file":
2470
tt.set_executability(entry.executable, trans_id)
2473
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2474
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2477
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2478
"""Produce a backup-style name that appears to be available"""
2482
yield "%s.~%d~" % (name, counter)
2484
for new_name in name_gen():
2485
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2489
def _entry_changes(file_id, entry, working_tree):
2490
"""Determine in which ways the inventory entry has changed.
2492
Returns booleans: has_contents, content_mod, meta_mod
2493
has_contents means there are currently contents, but they differ
2494
contents_mod means contents need to be modified
2495
meta_mod means the metadata needs to be modified
2497
cur_entry = working_tree.inventory[file_id]
2499
working_kind = working_tree.kind(file_id)
2502
has_contents = False
2505
if has_contents is True:
2506
if entry.kind != working_kind:
2507
contents_mod, meta_mod = True, False
2509
cur_entry._read_tree_state(working_tree.id2path(file_id),
2511
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2512
cur_entry._forget_tree_state()
2513
return has_contents, contents_mod, meta_mod
2516
def revert(working_tree, target_tree, filenames, backups=False,
2517
pb=DummyProgress(), change_reporter=None):
2518
"""Revert a working tree's contents to those of a target tree."""
2519
target_tree.lock_read()
2520
tt = TreeTransform(working_tree, pb)
2522
pp = ProgressPhase("Revert phase", 3, pb)
2523
conflicts, merge_modified = _prepare_revert_transform(
2524
working_tree, target_tree, tt, filenames, backups, pp)
2526
change_reporter = delta._ChangeReporter(
2527
unversioned_filter=working_tree.is_ignored)
2528
delta.report_changes(tt.iter_changes(), change_reporter)
2529
for conflict in conflicts:
2533
working_tree.set_merge_modified(merge_modified)
2535
target_tree.unlock()
2541
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2542
backups, pp, basis_tree=None,
2543
merge_modified=None):
2545
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2547
if merge_modified is None:
2548
merge_modified = working_tree.merge_modified()
2549
merge_modified = _alter_files(working_tree, target_tree, tt,
2550
child_pb, filenames, backups,
2551
merge_modified, basis_tree)
2555
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2557
raw_conflicts = resolve_conflicts(tt, child_pb,
2558
lambda t, c: conflict_pass(t, c, target_tree))
2561
conflicts = cook_conflicts(raw_conflicts, tt)
2562
return conflicts, merge_modified
2565
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2566
backups, merge_modified, basis_tree=None):
2567
if basis_tree is not None:
2568
basis_tree.lock_read()
2569
change_list = target_tree.iter_changes(working_tree,
2570
specific_files=specific_files, pb=pb)
2571
if target_tree.get_root_id() is None:
2577
for id_num, (file_id, path, changed_content, versioned, parent, name,
2578
kind, executable) in enumerate(change_list):
2579
if skip_root and file_id[0] is not None and parent[0] is None:
2581
trans_id = tt.trans_id_file_id(file_id)
2584
keep_content = False
2585
if kind[0] == 'file' and (backups or kind[1] is None):
2586
wt_sha1 = working_tree.get_file_sha1(file_id)
2587
if merge_modified.get(file_id) != wt_sha1:
2588
# acquire the basis tree lazily to prevent the
2589
# expense of accessing it when it's not needed ?
2590
# (Guessing, RBC, 200702)
2591
if basis_tree is None:
2592
basis_tree = working_tree.basis_tree()
2593
basis_tree.lock_read()
2594
if file_id in basis_tree:
2595
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2597
elif kind[1] is None and not versioned[1]:
2599
if kind[0] is not None:
2600
if not keep_content:
2601
tt.delete_contents(trans_id)
2602
elif kind[1] is not None:
2603
parent_trans_id = tt.trans_id_file_id(parent[0])
2604
by_parent = tt.by_parent()
2605
backup_name = _get_backup_name(name[0], by_parent,
2606
parent_trans_id, tt)
2607
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2608
new_trans_id = tt.create_path(name[0], parent_trans_id)
2609
if versioned == (True, True):
2610
tt.unversion_file(trans_id)
2611
tt.version_file(file_id, new_trans_id)
2612
# New contents should have the same unix perms as old
2615
trans_id = new_trans_id
2616
if kind[1] in ('directory', 'tree-reference'):
2617
tt.create_directory(trans_id)
2618
if kind[1] == 'tree-reference':
2619
revision = target_tree.get_reference_revision(file_id,
2621
tt.set_tree_reference(revision, trans_id)
2622
elif kind[1] == 'symlink':
2623
tt.create_symlink(target_tree.get_symlink_target(file_id),
2625
elif kind[1] == 'file':
2626
deferred_files.append((file_id, (trans_id, mode_id)))
2627
if basis_tree is None:
2628
basis_tree = working_tree.basis_tree()
2629
basis_tree.lock_read()
2630
new_sha1 = target_tree.get_file_sha1(file_id)
2631
if (file_id in basis_tree and new_sha1 ==
2632
basis_tree.get_file_sha1(file_id)):
2633
if file_id in merge_modified:
2634
del merge_modified[file_id]
2636
merge_modified[file_id] = new_sha1
2638
# preserve the execute bit when backing up
2639
if keep_content and executable[0] == executable[1]:
2640
tt.set_executability(executable[1], trans_id)
2641
elif kind[1] is not None:
2642
raise AssertionError(kind[1])
2643
if versioned == (False, True):
2644
tt.version_file(file_id, trans_id)
2645
if versioned == (True, False):
2646
tt.unversion_file(trans_id)
2647
if (name[1] is not None and
2648
(name[0] != name[1] or parent[0] != parent[1])):
2649
if name[1] == '' and parent[1] is None:
2650
parent_trans = ROOT_PARENT
2652
parent_trans = tt.trans_id_file_id(parent[1])
2653
tt.adjust_path(name[1], parent_trans, trans_id)
2654
if executable[0] != executable[1] and kind[1] == "file":
2655
tt.set_executability(executable[1], trans_id)
2656
if working_tree.supports_content_filtering():
2657
for index, ((trans_id, mode_id), bytes) in enumerate(
2658
target_tree.iter_files_bytes(deferred_files)):
2659
file_id = deferred_files[index][0]
2660
# We're reverting a tree to the target tree so using the
2661
# target tree to find the file path seems the best choice
2662
# here IMO - Ian C 27/Oct/2009
2663
filter_tree_path = target_tree.id2path(file_id)
2664
filters = working_tree._content_filter_stack(filter_tree_path)
2665
bytes = filtered_output_bytes(bytes, filters,
2666
ContentFilterContext(filter_tree_path, working_tree))
2667
tt.create_file(bytes, trans_id, mode_id)
2669
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2671
tt.create_file(bytes, trans_id, mode_id)
2673
if basis_tree is not None:
2675
return merge_modified
2678
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2679
"""Make many conflict-resolution attempts, but die if they fail"""
2680
if pass_func is None:
2681
pass_func = conflict_pass
2682
new_conflicts = set()
2685
pb.update('Resolution pass', n+1, 10)
2686
conflicts = tt.find_conflicts()
2687
if len(conflicts) == 0:
2688
return new_conflicts
2689
new_conflicts.update(pass_func(tt, conflicts))
2690
raise MalformedTransform(conflicts=conflicts)
2695
def conflict_pass(tt, conflicts, path_tree=None):
2696
"""Resolve some classes of conflicts.
2698
:param tt: The transform to resolve conflicts in
2699
:param conflicts: The conflicts to resolve
2700
:param path_tree: A Tree to get supplemental paths from
2702
new_conflicts = set()
2703
for c_type, conflict in ((c[0], c) for c in conflicts):
2704
if c_type == 'duplicate id':
2705
tt.unversion_file(conflict[1])
2706
new_conflicts.add((c_type, 'Unversioned existing file',
2707
conflict[1], conflict[2], ))
2708
elif c_type == 'duplicate':
2709
# files that were renamed take precedence
2710
final_parent = tt.final_parent(conflict[1])
2711
if tt.path_changed(conflict[1]):
2712
existing_file, new_file = conflict[2], conflict[1]
2714
existing_file, new_file = conflict[1], conflict[2]
2715
new_name = tt.final_name(existing_file)+'.moved'
2716
tt.adjust_path(new_name, final_parent, existing_file)
2717
new_conflicts.add((c_type, 'Moved existing file to',
2718
existing_file, new_file))
2719
elif c_type == 'parent loop':
2720
# break the loop by undoing one of the ops that caused the loop
2722
while not tt.path_changed(cur):
2723
cur = tt.final_parent(cur)
2724
new_conflicts.add((c_type, 'Cancelled move', cur,
2725
tt.final_parent(cur),))
2726
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2728
elif c_type == 'missing parent':
2729
trans_id = conflict[1]
2731
tt.cancel_deletion(trans_id)
2732
new_conflicts.add(('deleting parent', 'Not deleting',
2737
tt.final_name(trans_id)
2739
if path_tree is not None:
2740
file_id = tt.final_file_id(trans_id)
2742
file_id = tt.inactive_file_id(trans_id)
2743
entry = path_tree.inventory[file_id]
2744
# special-case the other tree root (move its
2745
# children to current root)
2746
if entry.parent_id is None:
2748
moved = _reparent_transform_children(
2749
tt, trans_id, tt.root)
2751
new_conflicts.add((c_type, 'Moved to root',
2754
parent_trans_id = tt.trans_id_file_id(
2756
tt.adjust_path(entry.name, parent_trans_id,
2759
tt.create_directory(trans_id)
2760
new_conflicts.add((c_type, 'Created directory', trans_id))
2761
elif c_type == 'unversioned parent':
2762
file_id = tt.inactive_file_id(conflict[1])
2763
# special-case the other tree root (move its children instead)
2764
if path_tree and file_id in path_tree:
2765
if path_tree.inventory[file_id].parent_id is None:
2767
tt.version_file(file_id, conflict[1])
2768
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2769
elif c_type == 'non-directory parent':
2770
parent_id = conflict[1]
2771
parent_parent = tt.final_parent(parent_id)
2772
parent_name = tt.final_name(parent_id)
2773
parent_file_id = tt.final_file_id(parent_id)
2774
new_parent_id = tt.new_directory(parent_name + '.new',
2775
parent_parent, parent_file_id)
2776
_reparent_transform_children(tt, parent_id, new_parent_id)
2777
if parent_file_id is not None:
2778
tt.unversion_file(parent_id)
2779
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2780
elif c_type == 'versioning no contents':
2781
tt.cancel_versioning(conflict[1])
2782
return new_conflicts
2785
def cook_conflicts(raw_conflicts, tt):
2786
"""Generate a list of cooked conflicts, sorted by file path"""
2787
from bzrlib.conflicts import Conflict
2788
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2789
return sorted(conflict_iter, key=Conflict.sort_key)
2792
def iter_cook_conflicts(raw_conflicts, tt):
2793
from bzrlib.conflicts import Conflict
2795
for conflict in raw_conflicts:
2796
c_type = conflict[0]
2797
action = conflict[1]
2798
modified_path = fp.get_path(conflict[2])
2799
modified_id = tt.final_file_id(conflict[2])
2800
if len(conflict) == 3:
2801
yield Conflict.factory(c_type, action=action, path=modified_path,
2802
file_id=modified_id)
2805
conflicting_path = fp.get_path(conflict[3])
2806
conflicting_id = tt.final_file_id(conflict[3])
2807
yield Conflict.factory(c_type, action=action, path=modified_path,
2808
file_id=modified_id,
2809
conflict_path=conflicting_path,
2810
conflict_file_id=conflicting_id)
2813
class _FileMover(object):
2814
"""Moves and deletes files for TreeTransform, tracking operations"""
2817
self.past_renames = []
2818
self.pending_deletions = []
2820
def rename(self, from_, to):
2821
"""Rename a file from one path to another. Functions like os.rename"""
2823
os.rename(from_, to)
2825
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2826
raise errors.FileExists(to, str(e))
2828
self.past_renames.append((from_, to))
2830
def pre_delete(self, from_, to):
2831
"""Rename a file out of the way and mark it for deletion.
2833
Unlike os.unlink, this works equally well for files and directories.
2834
:param from_: The current file path
2835
:param to: A temporary path for the file
2837
self.rename(from_, to)
2838
self.pending_deletions.append(to)
2841
"""Reverse all renames that have been performed"""
2842
for from_, to in reversed(self.past_renames):
2843
os.rename(to, from_)
2844
# after rollback, don't reuse _FileMover
2846
pending_deletions = None
2848
def apply_deletions(self):
2849
"""Apply all marked deletions"""
2850
for path in self.pending_deletions:
2852
# after apply_deletions, don't reuse _FileMover
2854
pending_deletions = None
added
removed
bzrlib/transform.py
