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 not None:
1059
parent = self._new_parent.get(trans_id)
1060
# if the parent directory is already in limbo (e.g. when building a
1061
# tree), choose a limbo name inside the parent, to reduce further
1063
use_direct_path = False
1064
if self._new_contents.get(parent) == 'directory':
1065
filename = self._new_name.get(trans_id)
1066
if filename is not None:
1067
if parent not in self._limbo_children:
1068
self._limbo_children[parent] = set()
1069
self._limbo_children_names[parent] = {}
1070
use_direct_path = True
1071
# the direct path can only be used if no other file has
1072
# already taken this pathname, i.e. if the name is unused, or
1073
# if it is already associated with this trans_id.
1074
elif self._case_sensitive_target:
1075
if (self._limbo_children_names[parent].get(filename)
1076
in (trans_id, None)):
1077
use_direct_path = True
1079
for l_filename, l_trans_id in\
1080
self._limbo_children_names[parent].iteritems():
1081
if l_trans_id == trans_id:
1083
if l_filename.lower() == filename.lower():
1086
use_direct_path = True
1089
limbo_name = pathjoin(self._limbo_files[parent], filename)
1090
self._limbo_children[parent].add(trans_id)
1091
self._limbo_children_names[parent][filename] = trans_id
1093
limbo_name = pathjoin(self._limbodir, trans_id)
1094
self._needs_rename.add(trans_id)
1095
self._limbo_files[trans_id] = limbo_name
1098
def adjust_path(self, name, parent, trans_id):
1099
previous_parent = self._new_parent.get(trans_id)
1100
previous_name = self._new_name.get(trans_id)
1101
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1102
if (trans_id in self._limbo_files and
1103
trans_id not in self._needs_rename):
1104
self._rename_in_limbo([trans_id])
1105
self._limbo_children[previous_parent].remove(trans_id)
1106
del self._limbo_children_names[previous_parent][previous_name]
1108
def _rename_in_limbo(self, trans_ids):
1109
"""Fix limbo names so that the right final path is produced.
1111
This means we outsmarted ourselves-- we tried to avoid renaming
1112
these files later by creating them with their final names in their
1113
final parents. But now the previous name or parent is no longer
1114
suitable, so we have to rename them.
1116
Even for trans_ids that have no new contents, we must remove their
1117
entries from _limbo_files, because they are now stale.
1119
for trans_id in trans_ids:
1120
old_path = self._limbo_files.pop(trans_id)
1121
if trans_id not in self._new_contents:
1123
new_path = self._limbo_name(trans_id)
1124
os.rename(old_path, new_path)
1126
def create_file(self, contents, trans_id, mode_id=None):
1127
"""Schedule creation of a new file.
1131
Contents is an iterator of strings, all of which will be written
1132
to the target destination.
1134
New file takes the permissions of any existing file with that id,
1135
unless mode_id is specified.
1137
name = self._limbo_name(trans_id)
1138
f = open(name, 'wb')
1141
unique_add(self._new_contents, trans_id, 'file')
1143
# Clean up the file, it never got registered so
1144
# TreeTransform.finalize() won't clean it up.
1149
f.writelines(contents)
1152
self._set_mode(trans_id, mode_id, S_ISREG)
1154
def _read_file_chunks(self, trans_id):
1155
cur_file = open(self._limbo_name(trans_id), 'rb')
1157
return cur_file.readlines()
1161
def _read_symlink_target(self, trans_id):
1162
return os.readlink(self._limbo_name(trans_id))
1164
def create_hardlink(self, path, trans_id):
1165
"""Schedule creation of a hard link"""
1166
name = self._limbo_name(trans_id)
1170
if e.errno != errno.EPERM:
1172
raise errors.HardLinkNotSupported(path)
1174
unique_add(self._new_contents, trans_id, 'file')
1176
# Clean up the file, it never got registered so
1177
# TreeTransform.finalize() won't clean it up.
1181
def create_directory(self, trans_id):
1182
"""Schedule creation of a new directory.
1184
See also new_directory.
1186
os.mkdir(self._limbo_name(trans_id))
1187
unique_add(self._new_contents, trans_id, 'directory')
1189
def create_symlink(self, target, trans_id):
1190
"""Schedule creation of a new symbolic link.
1192
target is a bytestring.
1193
See also new_symlink.
1196
os.symlink(target, self._limbo_name(trans_id))
1197
unique_add(self._new_contents, trans_id, 'symlink')
1200
path = FinalPaths(self).get_path(trans_id)
1203
raise UnableCreateSymlink(path=path)
1205
def cancel_creation(self, trans_id):
1206
"""Cancel the creation of new file contents."""
1207
del self._new_contents[trans_id]
1208
children = self._limbo_children.get(trans_id)
1209
# if this is a limbo directory with children, move them before removing
1211
if children is not None:
1212
self._rename_in_limbo(children)
1213
del self._limbo_children[trans_id]
1214
del self._limbo_children_names[trans_id]
1215
delete_any(self._limbo_name(trans_id))
1218
class TreeTransform(DiskTreeTransform):
1219
"""Represent a tree transformation.
1221
This object is designed to support incremental generation of the transform,
1224
However, it gives optimum performance when parent directories are created
1225
before their contents. The transform is then able to put child files
1226
directly in their parent directory, avoiding later renames.
1228
It is easy to produce malformed transforms, but they are generally
1229
harmless. Attempting to apply a malformed transform will cause an
1230
exception to be raised before any modifications are made to the tree.
1232
Many kinds of malformed transforms can be corrected with the
1233
resolve_conflicts function. The remaining ones indicate programming error,
1234
such as trying to create a file with no path.
1236
Two sets of file creation methods are supplied. Convenience methods are:
1241
These are composed of the low-level methods:
1243
* create_file or create_directory or create_symlink
1247
Transform/Transaction ids
1248
-------------------------
1249
trans_ids are temporary ids assigned to all files involved in a transform.
1250
It's possible, even common, that not all files in the Tree have trans_ids.
1252
trans_ids are used because filenames and file_ids are not good enough
1253
identifiers; filenames change, and not all files have file_ids. File-ids
1254
are also associated with trans-ids, so that moving a file moves its
1257
trans_ids are only valid for the TreeTransform that generated them.
1261
Limbo is a temporary directory use to hold new versions of files.
1262
Files are added to limbo by create_file, create_directory, create_symlink,
1263
and their convenience variants (new_*). Files may be removed from limbo
1264
using cancel_creation. Files are renamed from limbo into their final
1265
location as part of TreeTransform.apply
1267
Limbo must be cleaned up, by either calling TreeTransform.apply or
1268
calling TreeTransform.finalize.
1270
Files are placed into limbo inside their parent directories, where
1271
possible. This reduces subsequent renames, and makes operations involving
1272
lots of files faster. This optimization is only possible if the parent
1273
directory is created *before* creating any of its children, so avoid
1274
creating children before parents, where possible.
1278
This temporary directory is used by _FileMover for storing files that are
1279
about to be deleted. In case of rollback, the files will be restored.
1280
FileMover does not delete files until it is sure that a rollback will not
1283
def __init__(self, tree, pb=DummyProgress()):
1284
"""Note: a tree_write lock is taken on the tree.
1286
Use TreeTransform.finalize() to release the lock (can be omitted if
1287
TreeTransform.apply() called).
1289
tree.lock_tree_write()
1292
limbodir = urlutils.local_path_from_url(
1293
tree._transport.abspath('limbo'))
1297
if e.errno == errno.EEXIST:
1298
raise ExistingLimbo(limbodir)
1299
deletiondir = urlutils.local_path_from_url(
1300
tree._transport.abspath('pending-deletion'))
1302
os.mkdir(deletiondir)
1304
if e.errno == errno.EEXIST:
1305
raise errors.ExistingPendingDeletion(deletiondir)
1310
# Cache of realpath results, to speed up canonical_path
1311
self._realpaths = {}
1312
# Cache of relpath results, to speed up canonical_path
1314
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1315
tree.case_sensitive)
1316
self._deletiondir = deletiondir
1318
def canonical_path(self, path):
1319
"""Get the canonical tree-relative path"""
1320
# don't follow final symlinks
1321
abs = self._tree.abspath(path)
1322
if abs in self._relpaths:
1323
return self._relpaths[abs]
1324
dirname, basename = os.path.split(abs)
1325
if dirname not in self._realpaths:
1326
self._realpaths[dirname] = os.path.realpath(dirname)
1327
dirname = self._realpaths[dirname]
1328
abs = pathjoin(dirname, basename)
1329
if dirname in self._relpaths:
1330
relpath = pathjoin(self._relpaths[dirname], basename)
1331
relpath = relpath.rstrip('/\\')
1333
relpath = self._tree.relpath(abs)
1334
self._relpaths[abs] = relpath
1337
def tree_kind(self, trans_id):
1338
"""Determine the file kind in the working tree.
1340
Raises NoSuchFile if the file does not exist
1342
path = self._tree_id_paths.get(trans_id)
1344
raise NoSuchFile(None)
1346
return file_kind(self._tree.abspath(path))
1348
if e.errno != errno.ENOENT:
1351
raise NoSuchFile(path)
1353
def _set_mode(self, trans_id, mode_id, typefunc):
1354
"""Set the mode of new file contents.
1355
The mode_id is the existing file to get the mode from (often the same
1356
as trans_id). The operation is only performed if there's a mode match
1357
according to typefunc.
1362
old_path = self._tree_id_paths[mode_id]
1366
mode = os.stat(self._tree.abspath(old_path)).st_mode
1368
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1369
# Either old_path doesn't exist, or the parent of the
1370
# target is not a directory (but will be one eventually)
1371
# Either way, we know it doesn't exist *right now*
1372
# See also bug #248448
1377
os.chmod(self._limbo_name(trans_id), mode)
1379
def iter_tree_children(self, parent_id):
1380
"""Iterate through the entry's tree children, if any"""
1382
path = self._tree_id_paths[parent_id]
1386
children = os.listdir(self._tree.abspath(path))
1388
if not (osutils._is_error_enotdir(e)
1389
or e.errno in (errno.ENOENT, errno.ESRCH)):
1393
for child in children:
1394
childpath = joinpath(path, child)
1395
if self._tree.is_control_filename(childpath):
1397
yield self.trans_id_tree_path(childpath)
1399
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1400
"""Apply all changes to the inventory and filesystem.
1402
If filesystem or inventory conflicts are present, MalformedTransform
1405
If apply succeeds, finalize is not necessary.
1407
:param no_conflicts: if True, the caller guarantees there are no
1408
conflicts, so no check is made.
1409
:param precomputed_delta: An inventory delta to use instead of
1411
:param _mover: Supply an alternate FileMover, for testing
1413
if not no_conflicts:
1414
self._check_malformed()
1415
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1417
if precomputed_delta is None:
1418
child_pb.update('Apply phase', 0, 2)
1419
inventory_delta = self._generate_inventory_delta()
1422
inventory_delta = precomputed_delta
1425
mover = _FileMover()
1429
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1430
self._apply_removals(mover)
1431
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1432
modified_paths = self._apply_insertions(mover)
1437
mover.apply_deletions()
1440
self._tree.apply_inventory_delta(inventory_delta)
1443
return _TransformResults(modified_paths, self.rename_count)
1445
def _generate_inventory_delta(self):
1446
"""Generate an inventory delta for the current transform."""
1447
inventory_delta = []
1448
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1449
new_paths = self._inventory_altered()
1450
total_entries = len(new_paths) + len(self._removed_id)
1452
for num, trans_id in enumerate(self._removed_id):
1454
child_pb.update('removing file', num, total_entries)
1455
if trans_id == self._new_root:
1456
file_id = self._tree.get_root_id()
1458
file_id = self.tree_file_id(trans_id)
1459
# File-id isn't really being deleted, just moved
1460
if file_id in self._r_new_id:
1462
path = self._tree_id_paths[trans_id]
1463
inventory_delta.append((path, None, file_id, None))
1464
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1466
entries = self._tree.iter_entries_by_dir(
1467
new_path_file_ids.values())
1468
old_paths = dict((e.file_id, p) for p, e in entries)
1470
for num, (path, trans_id) in enumerate(new_paths):
1472
child_pb.update('adding file',
1473
num + len(self._removed_id), total_entries)
1474
file_id = new_path_file_ids[trans_id]
1479
kind = self.final_kind(trans_id)
1481
kind = self._tree.stored_kind(file_id)
1482
parent_trans_id = self.final_parent(trans_id)
1483
parent_file_id = new_path_file_ids.get(parent_trans_id)
1484
if parent_file_id is None:
1485
parent_file_id = self.final_file_id(parent_trans_id)
1486
if trans_id in self._new_reference_revision:
1487
new_entry = inventory.TreeReference(
1489
self._new_name[trans_id],
1490
self.final_file_id(self._new_parent[trans_id]),
1491
None, self._new_reference_revision[trans_id])
1493
new_entry = inventory.make_entry(kind,
1494
self.final_name(trans_id),
1495
parent_file_id, file_id)
1496
old_path = old_paths.get(new_entry.file_id)
1497
new_executability = self._new_executability.get(trans_id)
1498
if new_executability is not None:
1499
new_entry.executable = new_executability
1500
inventory_delta.append(
1501
(old_path, path, new_entry.file_id, new_entry))
1504
return inventory_delta
1506
def _apply_removals(self, mover):
1507
"""Perform tree operations that remove directory/inventory names.
1509
That is, delete files that are to be deleted, and put any files that
1510
need renaming into limbo. This must be done in strict child-to-parent
1513
If inventory_delta is None, no inventory delta generation is performed.
1515
tree_paths = list(self._tree_path_ids.iteritems())
1516
tree_paths.sort(reverse=True)
1517
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1519
for num, data in enumerate(tree_paths):
1520
path, trans_id = data
1521
child_pb.update('removing file', num, len(tree_paths))
1522
full_path = self._tree.abspath(path)
1523
if trans_id in self._removed_contents:
1524
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1526
elif trans_id in self._new_name or trans_id in \
1529
mover.rename(full_path, self._limbo_name(trans_id))
1531
if e.errno != errno.ENOENT:
1534
self.rename_count += 1
1538
def _apply_insertions(self, mover):
1539
"""Perform tree operations that insert directory/inventory names.
1541
That is, create any files that need to be created, and restore from
1542
limbo any files that needed renaming. This must be done in strict
1543
parent-to-child order.
1545
If inventory_delta is None, no inventory delta is calculated, and
1546
no list of modified paths is returned.
1548
new_paths = self.new_paths(filesystem_only=True)
1550
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1552
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1554
for num, (path, trans_id) in enumerate(new_paths):
1556
child_pb.update('adding file', num, len(new_paths))
1557
full_path = self._tree.abspath(path)
1558
if trans_id in self._needs_rename:
1560
mover.rename(self._limbo_name(trans_id), full_path)
1562
# We may be renaming a dangling inventory id
1563
if e.errno != errno.ENOENT:
1566
self.rename_count += 1
1567
if (trans_id in self._new_contents or
1568
self.path_changed(trans_id)):
1569
if trans_id in self._new_contents:
1570
modified_paths.append(full_path)
1571
if trans_id in self._new_executability:
1572
self._set_executability(path, trans_id)
1575
self._new_contents.clear()
1576
return modified_paths
1579
class TransformPreview(DiskTreeTransform):
1580
"""A TreeTransform for generating preview trees.
1582
Unlike TreeTransform, this version works when the input tree is a
1583
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1584
unversioned files in the input tree.
1587
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1589
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1590
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1592
def canonical_path(self, path):
1595
def tree_kind(self, trans_id):
1596
path = self._tree_id_paths.get(trans_id)
1598
raise NoSuchFile(None)
1599
file_id = self._tree.path2id(path)
1600
return self._tree.kind(file_id)
1602
def _set_mode(self, trans_id, mode_id, typefunc):
1603
"""Set the mode of new file contents.
1604
The mode_id is the existing file to get the mode from (often the same
1605
as trans_id). The operation is only performed if there's a mode match
1606
according to typefunc.
1608
# is it ok to ignore this? probably
1611
def iter_tree_children(self, parent_id):
1612
"""Iterate through the entry's tree children, if any"""
1614
path = self._tree_id_paths[parent_id]
1617
file_id = self.tree_file_id(parent_id)
1620
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1621
children = getattr(entry, 'children', {})
1622
for child in children:
1623
childpath = joinpath(path, child)
1624
yield self.trans_id_tree_path(childpath)
1627
class _PreviewTree(tree.Tree):
1628
"""Partial implementation of Tree to support show_diff_trees"""
1630
def __init__(self, transform):
1631
self._transform = transform
1632
self._final_paths = FinalPaths(transform)
1633
self.__by_parent = None
1634
self._parent_ids = []
1635
self._all_children_cache = {}
1636
self._path2trans_id_cache = {}
1637
self._final_name_cache = {}
1638
self._iter_changes_cache = dict((c[0], c) for c in
1639
self._transform.iter_changes())
1641
def _content_change(self, file_id):
1642
"""Return True if the content of this file changed"""
1643
changes = self._iter_changes_cache.get(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, fallback_check):
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 fallback_check(file_id)
1727
def has_id(self, file_id):
1728
return self._has_id(file_id, self._transform._tree.has_id)
1730
def has_or_had_id(self, file_id):
1731
return self._has_id(file_id, self._transform._tree.has_or_had_id)
1733
def _path2trans_id(self, path):
1734
# We must not use None here, because that is a valid value to store.
1735
trans_id = self._path2trans_id_cache.get(path, object)
1736
if trans_id is not object:
1738
segments = splitpath(path)
1739
cur_parent = self._transform.root
1740
for cur_segment in segments:
1741
for child in self._all_children(cur_parent):
1742
final_name = self._final_name_cache.get(child)
1743
if final_name is None:
1744
final_name = self._transform.final_name(child)
1745
self._final_name_cache[child] = final_name
1746
if final_name == cur_segment:
1750
self._path2trans_id_cache[path] = None
1752
self._path2trans_id_cache[path] = cur_parent
1755
def path2id(self, path):
1756
return self._transform.final_file_id(self._path2trans_id(path))
1758
def id2path(self, file_id):
1759
trans_id = self._transform.trans_id_file_id(file_id)
1761
return self._final_paths._determine_path(trans_id)
1763
raise errors.NoSuchId(self, file_id)
1765
def _all_children(self, trans_id):
1766
children = self._all_children_cache.get(trans_id)
1767
if children is not None:
1769
children = set(self._transform.iter_tree_children(trans_id))
1770
# children in the _new_parent set are provided by _by_parent.
1771
children.difference_update(self._transform._new_parent.keys())
1772
children.update(self._by_parent.get(trans_id, []))
1773
self._all_children_cache[trans_id] = children
1776
def iter_children(self, file_id):
1777
trans_id = self._transform.trans_id_file_id(file_id)
1778
for child_trans_id in self._all_children(trans_id):
1779
yield self._transform.final_file_id(child_trans_id)
1782
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1783
in self._transform._tree.extras())
1784
possible_extras.update(self._transform._new_contents)
1785
possible_extras.update(self._transform._removed_id)
1786
for trans_id in possible_extras:
1787
if self._transform.final_file_id(trans_id) is None:
1788
yield self._final_paths._determine_path(trans_id)
1790
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1791
yield_parents=False):
1792
for trans_id, parent_file_id in ordered_entries:
1793
file_id = self._transform.final_file_id(trans_id)
1796
if (specific_file_ids is not None
1797
and file_id not in specific_file_ids):
1800
kind = self._transform.final_kind(trans_id)
1802
kind = self._transform._tree.stored_kind(file_id)
1803
new_entry = inventory.make_entry(
1805
self._transform.final_name(trans_id),
1806
parent_file_id, file_id)
1807
yield new_entry, trans_id
1809
def _list_files_by_dir(self):
1810
todo = [ROOT_PARENT]
1812
while len(todo) > 0:
1814
parent_file_id = self._transform.final_file_id(parent)
1815
children = list(self._all_children(parent))
1816
paths = dict(zip(children, self._final_paths.get_paths(children)))
1817
children.sort(key=paths.get)
1818
todo.extend(reversed(children))
1819
for trans_id in children:
1820
ordered_ids.append((trans_id, parent_file_id))
1823
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1824
# This may not be a maximally efficient implementation, but it is
1825
# reasonably straightforward. An implementation that grafts the
1826
# TreeTransform changes onto the tree's iter_entries_by_dir results
1827
# might be more efficient, but requires tricky inferences about stack
1829
ordered_ids = self._list_files_by_dir()
1830
for entry, trans_id in self._make_inv_entries(ordered_ids,
1831
specific_file_ids, yield_parents=yield_parents):
1832
yield unicode(self._final_paths.get_path(trans_id)), entry
1834
def _iter_entries_for_dir(self, dir_path):
1835
"""Return path, entry for items in a directory without recursing down."""
1836
dir_file_id = self.path2id(dir_path)
1838
for file_id in self.iter_children(dir_file_id):
1839
trans_id = self._transform.trans_id_file_id(file_id)
1840
ordered_ids.append((trans_id, file_id))
1841
for entry, trans_id in self._make_inv_entries(ordered_ids):
1842
yield unicode(self._final_paths.get_path(trans_id)), entry
1844
def list_files(self, include_root=False, from_dir=None, recursive=True):
1845
"""See WorkingTree.list_files."""
1846
# XXX This should behave like WorkingTree.list_files, but is really
1847
# more like RevisionTree.list_files.
1851
prefix = from_dir + '/'
1852
entries = self.iter_entries_by_dir()
1853
for path, entry in entries:
1854
if entry.name == '' and not include_root:
1857
if not path.startswith(prefix):
1859
path = path[len(prefix):]
1860
yield path, 'V', entry.kind, entry.file_id, entry
1862
if from_dir is None and include_root is True:
1863
root_entry = inventory.make_entry('directory', '',
1864
ROOT_PARENT, self.get_root_id())
1865
yield '', 'V', 'directory', root_entry.file_id, root_entry
1866
entries = self._iter_entries_for_dir(from_dir or '')
1867
for path, entry in entries:
1868
yield path, 'V', entry.kind, entry.file_id, entry
1870
def kind(self, file_id):
1871
trans_id = self._transform.trans_id_file_id(file_id)
1872
return self._transform.final_kind(trans_id)
1874
def stored_kind(self, file_id):
1875
trans_id = self._transform.trans_id_file_id(file_id)
1877
return self._transform._new_contents[trans_id]
1879
return self._transform._tree.stored_kind(file_id)
1881
def get_file_mtime(self, file_id, path=None):
1882
"""See Tree.get_file_mtime"""
1883
if not self._content_change(file_id):
1884
return self._transform._tree.get_file_mtime(file_id)
1885
return self._stat_limbo_file(file_id).st_mtime
1887
def _file_size(self, entry, stat_value):
1888
return self.get_file_size(entry.file_id)
1890
def get_file_size(self, file_id):
1891
"""See Tree.get_file_size"""
1892
if self.kind(file_id) == 'file':
1893
return self._transform._tree.get_file_size(file_id)
1897
def get_file_sha1(self, file_id, path=None, stat_value=None):
1898
trans_id = self._transform.trans_id_file_id(file_id)
1899
kind = self._transform._new_contents.get(trans_id)
1901
return self._transform._tree.get_file_sha1(file_id)
1903
fileobj = self.get_file(file_id)
1905
return sha_file(fileobj)
1909
def is_executable(self, file_id, path=None):
1912
trans_id = self._transform.trans_id_file_id(file_id)
1914
return self._transform._new_executability[trans_id]
1917
return self._transform._tree.is_executable(file_id, path)
1919
if e.errno == errno.ENOENT:
1922
except errors.NoSuchId:
1925
def path_content_summary(self, path):
1926
trans_id = self._path2trans_id(path)
1927
tt = self._transform
1928
tree_path = tt._tree_id_paths.get(trans_id)
1929
kind = tt._new_contents.get(trans_id)
1931
if tree_path is None or trans_id in tt._removed_contents:
1932
return 'missing', None, None, None
1933
summary = tt._tree.path_content_summary(tree_path)
1934
kind, size, executable, link_or_sha1 = summary
1937
limbo_name = tt._limbo_name(trans_id)
1938
if trans_id in tt._new_reference_revision:
1939
kind = 'tree-reference'
1941
statval = os.lstat(limbo_name)
1942
size = statval.st_size
1943
if not supports_executable():
1946
executable = statval.st_mode & S_IEXEC
1950
if kind == 'symlink':
1951
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1952
if supports_executable():
1953
executable = tt._new_executability.get(trans_id, executable)
1954
return kind, size, executable, link_or_sha1
1956
def iter_changes(self, from_tree, include_unchanged=False,
1957
specific_files=None, pb=None, extra_trees=None,
1958
require_versioned=True, want_unversioned=False):
1959
"""See InterTree.iter_changes.
1961
This has a fast path that is only used when the from_tree matches
1962
the transform tree, and no fancy options are supplied.
1964
if (from_tree is not self._transform._tree or include_unchanged or
1965
specific_files or want_unversioned):
1966
return tree.InterTree(from_tree, self).iter_changes(
1967
include_unchanged=include_unchanged,
1968
specific_files=specific_files,
1970
extra_trees=extra_trees,
1971
require_versioned=require_versioned,
1972
want_unversioned=want_unversioned)
1973
if want_unversioned:
1974
raise ValueError('want_unversioned is not supported')
1975
return self._transform.iter_changes()
1977
def get_file(self, file_id, path=None):
1978
"""See Tree.get_file"""
1979
if not self._content_change(file_id):
1980
return self._transform._tree.get_file(file_id, path)
1981
trans_id = self._transform.trans_id_file_id(file_id)
1982
name = self._transform._limbo_name(trans_id)
1983
return open(name, 'rb')
1985
def get_file_with_stat(self, file_id, path=None):
1986
return self.get_file(file_id, path), None
1988
def annotate_iter(self, file_id,
1989
default_revision=_mod_revision.CURRENT_REVISION):
1990
changes = self._iter_changes_cache.get(file_id)
1994
changed_content, versioned, kind = (changes[2], changes[3],
1998
get_old = (kind[0] == 'file' and versioned[0])
2000
old_annotation = self._transform._tree.annotate_iter(file_id,
2001
default_revision=default_revision)
2005
return old_annotation
2006
if not changed_content:
2007
return old_annotation
2008
# TODO: This is doing something similar to what WT.annotate_iter is
2009
# doing, however it fails slightly because it doesn't know what
2010
# the *other* revision_id is, so it doesn't know how to give the
2011
# other as the origin for some lines, they all get
2012
# 'default_revision'
2013
# It would be nice to be able to use the new Annotator based
2014
# approach, as well.
2015
return annotate.reannotate([old_annotation],
2016
self.get_file(file_id).readlines(),
2019
def get_symlink_target(self, file_id):
2020
"""See Tree.get_symlink_target"""
2021
if not self._content_change(file_id):
2022
return self._transform._tree.get_symlink_target(file_id)
2023
trans_id = self._transform.trans_id_file_id(file_id)
2024
name = self._transform._limbo_name(trans_id)
2025
return osutils.readlink(name)
2027
def walkdirs(self, prefix=''):
2028
pending = [self._transform.root]
2029
while len(pending) > 0:
2030
parent_id = pending.pop()
2033
prefix = prefix.rstrip('/')
2034
parent_path = self._final_paths.get_path(parent_id)
2035
parent_file_id = self._transform.final_file_id(parent_id)
2036
for child_id in self._all_children(parent_id):
2037
path_from_root = self._final_paths.get_path(child_id)
2038
basename = self._transform.final_name(child_id)
2039
file_id = self._transform.final_file_id(child_id)
2041
kind = self._transform.final_kind(child_id)
2042
versioned_kind = kind
2045
versioned_kind = self._transform._tree.stored_kind(file_id)
2046
if versioned_kind == 'directory':
2047
subdirs.append(child_id)
2048
children.append((path_from_root, basename, kind, None,
2049
file_id, versioned_kind))
2051
if parent_path.startswith(prefix):
2052
yield (parent_path, parent_file_id), children
2053
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2056
def get_parent_ids(self):
2057
return self._parent_ids
2059
def set_parent_ids(self, parent_ids):
2060
self._parent_ids = parent_ids
2062
def get_revision_tree(self, revision_id):
2063
return self._transform._tree.get_revision_tree(revision_id)
2066
def joinpath(parent, child):
2067
"""Join tree-relative paths, handling the tree root specially"""
2068
if parent is None or parent == "":
2071
return pathjoin(parent, child)
2074
class FinalPaths(object):
2075
"""Make path calculation cheap by memoizing paths.
2077
The underlying tree must not be manipulated between calls, or else
2078
the results will likely be incorrect.
2080
def __init__(self, transform):
2081
object.__init__(self)
2082
self._known_paths = {}
2083
self.transform = transform
2085
def _determine_path(self, trans_id):
2086
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2088
name = self.transform.final_name(trans_id)
2089
parent_id = self.transform.final_parent(trans_id)
2090
if parent_id == self.transform.root:
2093
return pathjoin(self.get_path(parent_id), name)
2095
def get_path(self, trans_id):
2096
"""Find the final path associated with a trans_id"""
2097
if trans_id not in self._known_paths:
2098
self._known_paths[trans_id] = self._determine_path(trans_id)
2099
return self._known_paths[trans_id]
2101
def get_paths(self, trans_ids):
2102
return [(self.get_path(t), t) for t in trans_ids]
2106
def topology_sorted_ids(tree):
2107
"""Determine the topological order of the ids in a tree"""
2108
file_ids = list(tree)
2109
file_ids.sort(key=tree.id2path)
2113
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2114
delta_from_tree=False):
2115
"""Create working tree for a branch, using a TreeTransform.
2117
This function should be used on empty trees, having a tree root at most.
2118
(see merge and revert functionality for working with existing trees)
2120
Existing files are handled like so:
2122
- Existing bzrdirs take precedence over creating new items. They are
2123
created as '%s.diverted' % name.
2124
- Otherwise, if the content on disk matches the content we are building,
2125
it is silently replaced.
2126
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2128
:param tree: The tree to convert wt into a copy of
2129
:param wt: The working tree that files will be placed into
2130
:param accelerator_tree: A tree which can be used for retrieving file
2131
contents more quickly than tree itself, i.e. a workingtree. tree
2132
will be used for cases where accelerator_tree's content is different.
2133
:param hardlink: If true, hard-link files to accelerator_tree, where
2134
possible. accelerator_tree must implement abspath, i.e. be a
2136
:param delta_from_tree: If true, build_tree may use the input Tree to
2137
generate the inventory delta.
2139
wt.lock_tree_write()
2143
if accelerator_tree is not None:
2144
accelerator_tree.lock_read()
2146
return _build_tree(tree, wt, accelerator_tree, hardlink,
2149
if accelerator_tree is not None:
2150
accelerator_tree.unlock()
2157
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2158
"""See build_tree."""
2159
for num, _unused in enumerate(wt.all_file_ids()):
2160
if num > 0: # more than just a root
2161
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2162
existing_files = set()
2163
for dir, files in wt.walkdirs():
2164
existing_files.update(f[0] for f in files)
2166
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2167
pp = ProgressPhase("Build phase", 2, top_pb)
2168
if tree.inventory.root is not None:
2169
# This is kind of a hack: we should be altering the root
2170
# as part of the regular tree shape diff logic.
2171
# The conditional test here is to avoid doing an
2172
# expensive operation (flush) every time the root id
2173
# is set within the tree, nor setting the root and thus
2174
# marking the tree as dirty, because we use two different
2175
# idioms here: tree interfaces and inventory interfaces.
2176
if wt.get_root_id() != tree.get_root_id():
2177
wt.set_root_id(tree.get_root_id())
2179
tt = TreeTransform(wt)
2183
file_trans_id[wt.get_root_id()] = \
2184
tt.trans_id_tree_file_id(wt.get_root_id())
2185
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2187
deferred_contents = []
2189
total = len(tree.inventory)
2191
precomputed_delta = []
2193
precomputed_delta = None
2194
for num, (tree_path, entry) in \
2195
enumerate(tree.inventory.iter_entries_by_dir()):
2196
pb.update("Building tree", num - len(deferred_contents), total)
2197
if entry.parent_id is None:
2200
file_id = entry.file_id
2202
precomputed_delta.append((None, tree_path, file_id, entry))
2203
if tree_path in existing_files:
2204
target_path = wt.abspath(tree_path)
2205
kind = file_kind(target_path)
2206
if kind == "directory":
2208
bzrdir.BzrDir.open(target_path)
2209
except errors.NotBranchError:
2213
if (file_id not in divert and
2214
_content_match(tree, entry, file_id, kind,
2216
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2217
if kind == 'directory':
2219
parent_id = file_trans_id[entry.parent_id]
2220
if entry.kind == 'file':
2221
# We *almost* replicate new_by_entry, so that we can defer
2222
# getting the file text, and get them all at once.
2223
trans_id = tt.create_path(entry.name, parent_id)
2224
file_trans_id[file_id] = trans_id
2225
tt.version_file(file_id, trans_id)
2226
executable = tree.is_executable(file_id, tree_path)
2228
tt.set_executability(executable, trans_id)
2229
trans_data = (trans_id, tree_path)
2230
deferred_contents.append((file_id, trans_data))
2232
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2235
new_trans_id = file_trans_id[file_id]
2236
old_parent = tt.trans_id_tree_path(tree_path)
2237
_reparent_children(tt, old_parent, new_trans_id)
2238
offset = num + 1 - len(deferred_contents)
2239
_create_files(tt, tree, deferred_contents, pb, offset,
2240
accelerator_tree, hardlink)
2244
divert_trans = set(file_trans_id[f] for f in divert)
2245
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2246
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2247
if len(raw_conflicts) > 0:
2248
precomputed_delta = None
2249
conflicts = cook_conflicts(raw_conflicts, tt)
2250
for conflict in conflicts:
2253
wt.add_conflicts(conflicts)
2254
except errors.UnsupportedOperation:
2256
result = tt.apply(no_conflicts=True,
2257
precomputed_delta=precomputed_delta)
2264
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2266
total = len(desired_files) + offset
2268
if accelerator_tree is None:
2269
new_desired_files = desired_files
2271
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2272
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2273
in iter if not (c or e[0] != e[1]))
2274
new_desired_files = []
2276
for file_id, (trans_id, tree_path) in desired_files:
2277
accelerator_path = unchanged.get(file_id)
2278
if accelerator_path is None:
2279
new_desired_files.append((file_id, (trans_id, tree_path)))
2281
pb.update('Adding file contents', count + offset, total)
2283
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2286
contents = accelerator_tree.get_file(file_id, accelerator_path)
2287
if wt.supports_content_filtering():
2288
filters = wt._content_filter_stack(tree_path)
2289
contents = filtered_output_bytes(contents, filters,
2290
ContentFilterContext(tree_path, tree))
2292
tt.create_file(contents, trans_id)
2296
except AttributeError:
2297
# after filtering, contents may no longer be file-like
2301
for count, ((trans_id, tree_path), contents) in enumerate(
2302
tree.iter_files_bytes(new_desired_files)):
2303
if wt.supports_content_filtering():
2304
filters = wt._content_filter_stack(tree_path)
2305
contents = filtered_output_bytes(contents, filters,
2306
ContentFilterContext(tree_path, tree))
2307
tt.create_file(contents, trans_id)
2308
pb.update('Adding file contents', count + offset, total)
2311
def _reparent_children(tt, old_parent, new_parent):
2312
for child in tt.iter_tree_children(old_parent):
2313
tt.adjust_path(tt.final_name(child), new_parent, child)
2315
def _reparent_transform_children(tt, old_parent, new_parent):
2316
by_parent = tt.by_parent()
2317
for child in by_parent[old_parent]:
2318
tt.adjust_path(tt.final_name(child), new_parent, child)
2319
return by_parent[old_parent]
2321
def _content_match(tree, entry, file_id, kind, target_path):
2322
if entry.kind != kind:
2324
if entry.kind == "directory":
2326
if entry.kind == "file":
2327
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2329
elif entry.kind == "symlink":
2330
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2335
def resolve_checkout(tt, conflicts, divert):
2336
new_conflicts = set()
2337
for c_type, conflict in ((c[0], c) for c in conflicts):
2338
# Anything but a 'duplicate' would indicate programmer error
2339
if c_type != 'duplicate':
2340
raise AssertionError(c_type)
2341
# Now figure out which is new and which is old
2342
if tt.new_contents(conflict[1]):
2343
new_file = conflict[1]
2344
old_file = conflict[2]
2346
new_file = conflict[2]
2347
old_file = conflict[1]
2349
# We should only get here if the conflict wasn't completely
2351
final_parent = tt.final_parent(old_file)
2352
if new_file in divert:
2353
new_name = tt.final_name(old_file)+'.diverted'
2354
tt.adjust_path(new_name, final_parent, new_file)
2355
new_conflicts.add((c_type, 'Diverted to',
2356
new_file, old_file))
2358
new_name = tt.final_name(old_file)+'.moved'
2359
tt.adjust_path(new_name, final_parent, old_file)
2360
new_conflicts.add((c_type, 'Moved existing file to',
2361
old_file, new_file))
2362
return new_conflicts
2365
def new_by_entry(tt, entry, parent_id, tree):
2366
"""Create a new file according to its inventory entry"""
2370
contents = tree.get_file(entry.file_id).readlines()
2371
executable = tree.is_executable(entry.file_id)
2372
return tt.new_file(name, parent_id, contents, entry.file_id,
2374
elif kind in ('directory', 'tree-reference'):
2375
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2376
if kind == 'tree-reference':
2377
tt.set_tree_reference(entry.reference_revision, trans_id)
2379
elif kind == 'symlink':
2380
target = tree.get_symlink_target(entry.file_id)
2381
return tt.new_symlink(name, parent_id, target, entry.file_id)
2383
raise errors.BadFileKindError(name, kind)
2386
@deprecated_function(deprecated_in((1, 9, 0)))
2387
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2388
"""Create new file contents according to an inventory entry.
2390
DEPRECATED. Use create_from_tree instead.
2392
if entry.kind == "file":
2394
lines = tree.get_file(entry.file_id).readlines()
2395
tt.create_file(lines, trans_id, mode_id=mode_id)
2396
elif entry.kind == "symlink":
2397
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2398
elif entry.kind == "directory":
2399
tt.create_directory(trans_id)
2402
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2403
"""Create new file contents according to tree contents."""
2404
kind = tree.kind(file_id)
2405
if kind == 'directory':
2406
tt.create_directory(trans_id)
2407
elif kind == "file":
2409
tree_file = tree.get_file(file_id)
2411
bytes = tree_file.readlines()
2414
tt.create_file(bytes, trans_id)
2415
elif kind == "symlink":
2416
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2418
raise AssertionError('Unknown kind %r' % kind)
2421
def create_entry_executability(tt, entry, trans_id):
2422
"""Set the executability of a trans_id according to an inventory entry"""
2423
if entry.kind == "file":
2424
tt.set_executability(entry.executable, trans_id)
2427
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2428
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2431
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2432
"""Produce a backup-style name that appears to be available"""
2436
yield "%s.~%d~" % (name, counter)
2438
for new_name in name_gen():
2439
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2443
def _entry_changes(file_id, entry, working_tree):
2444
"""Determine in which ways the inventory entry has changed.
2446
Returns booleans: has_contents, content_mod, meta_mod
2447
has_contents means there are currently contents, but they differ
2448
contents_mod means contents need to be modified
2449
meta_mod means the metadata needs to be modified
2451
cur_entry = working_tree.inventory[file_id]
2453
working_kind = working_tree.kind(file_id)
2456
has_contents = False
2459
if has_contents is True:
2460
if entry.kind != working_kind:
2461
contents_mod, meta_mod = True, False
2463
cur_entry._read_tree_state(working_tree.id2path(file_id),
2465
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2466
cur_entry._forget_tree_state()
2467
return has_contents, contents_mod, meta_mod
2470
def revert(working_tree, target_tree, filenames, backups=False,
2471
pb=DummyProgress(), change_reporter=None):
2472
"""Revert a working tree's contents to those of a target tree."""
2473
target_tree.lock_read()
2474
tt = TreeTransform(working_tree, pb)
2476
pp = ProgressPhase("Revert phase", 3, pb)
2477
conflicts, merge_modified = _prepare_revert_transform(
2478
working_tree, target_tree, tt, filenames, backups, pp)
2480
change_reporter = delta._ChangeReporter(
2481
unversioned_filter=working_tree.is_ignored)
2482
delta.report_changes(tt.iter_changes(), change_reporter)
2483
for conflict in conflicts:
2487
working_tree.set_merge_modified(merge_modified)
2489
target_tree.unlock()
2495
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2496
backups, pp, basis_tree=None,
2497
merge_modified=None):
2499
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2501
if merge_modified is None:
2502
merge_modified = working_tree.merge_modified()
2503
merge_modified = _alter_files(working_tree, target_tree, tt,
2504
child_pb, filenames, backups,
2505
merge_modified, basis_tree)
2509
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2511
raw_conflicts = resolve_conflicts(tt, child_pb,
2512
lambda t, c: conflict_pass(t, c, target_tree))
2515
conflicts = cook_conflicts(raw_conflicts, tt)
2516
return conflicts, merge_modified
2519
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2520
backups, merge_modified, basis_tree=None):
2521
if basis_tree is not None:
2522
basis_tree.lock_read()
2523
change_list = target_tree.iter_changes(working_tree,
2524
specific_files=specific_files, pb=pb)
2525
if target_tree.get_root_id() is None:
2531
for id_num, (file_id, path, changed_content, versioned, parent, name,
2532
kind, executable) in enumerate(change_list):
2533
if skip_root and file_id[0] is not None and parent[0] is None:
2535
trans_id = tt.trans_id_file_id(file_id)
2538
keep_content = False
2539
if kind[0] == 'file' and (backups or kind[1] is None):
2540
wt_sha1 = working_tree.get_file_sha1(file_id)
2541
if merge_modified.get(file_id) != wt_sha1:
2542
# acquire the basis tree lazily to prevent the
2543
# expense of accessing it when it's not needed ?
2544
# (Guessing, RBC, 200702)
2545
if basis_tree is None:
2546
basis_tree = working_tree.basis_tree()
2547
basis_tree.lock_read()
2548
if file_id in basis_tree:
2549
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2551
elif kind[1] is None and not versioned[1]:
2553
if kind[0] is not None:
2554
if not keep_content:
2555
tt.delete_contents(trans_id)
2556
elif kind[1] is not None:
2557
parent_trans_id = tt.trans_id_file_id(parent[0])
2558
by_parent = tt.by_parent()
2559
backup_name = _get_backup_name(name[0], by_parent,
2560
parent_trans_id, tt)
2561
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2562
new_trans_id = tt.create_path(name[0], parent_trans_id)
2563
if versioned == (True, True):
2564
tt.unversion_file(trans_id)
2565
tt.version_file(file_id, new_trans_id)
2566
# New contents should have the same unix perms as old
2569
trans_id = new_trans_id
2570
if kind[1] in ('directory', 'tree-reference'):
2571
tt.create_directory(trans_id)
2572
if kind[1] == 'tree-reference':
2573
revision = target_tree.get_reference_revision(file_id,
2575
tt.set_tree_reference(revision, trans_id)
2576
elif kind[1] == 'symlink':
2577
tt.create_symlink(target_tree.get_symlink_target(file_id),
2579
elif kind[1] == 'file':
2580
deferred_files.append((file_id, (trans_id, mode_id)))
2581
if basis_tree is None:
2582
basis_tree = working_tree.basis_tree()
2583
basis_tree.lock_read()
2584
new_sha1 = target_tree.get_file_sha1(file_id)
2585
if (file_id in basis_tree and new_sha1 ==
2586
basis_tree.get_file_sha1(file_id)):
2587
if file_id in merge_modified:
2588
del merge_modified[file_id]
2590
merge_modified[file_id] = new_sha1
2592
# preserve the execute bit when backing up
2593
if keep_content and executable[0] == executable[1]:
2594
tt.set_executability(executable[1], trans_id)
2595
elif kind[1] is not None:
2596
raise AssertionError(kind[1])
2597
if versioned == (False, True):
2598
tt.version_file(file_id, trans_id)
2599
if versioned == (True, False):
2600
tt.unversion_file(trans_id)
2601
if (name[1] is not None and
2602
(name[0] != name[1] or parent[0] != parent[1])):
2603
if name[1] == '' and parent[1] is None:
2604
parent_trans = ROOT_PARENT
2606
parent_trans = tt.trans_id_file_id(parent[1])
2607
tt.adjust_path(name[1], parent_trans, trans_id)
2608
if executable[0] != executable[1] and kind[1] == "file":
2609
tt.set_executability(executable[1], trans_id)
2610
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2612
tt.create_file(bytes, trans_id, mode_id)
2614
if basis_tree is not None:
2616
return merge_modified
2619
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2620
"""Make many conflict-resolution attempts, but die if they fail"""
2621
if pass_func is None:
2622
pass_func = conflict_pass
2623
new_conflicts = set()
2626
pb.update('Resolution pass', n+1, 10)
2627
conflicts = tt.find_conflicts()
2628
if len(conflicts) == 0:
2629
return new_conflicts
2630
new_conflicts.update(pass_func(tt, conflicts))
2631
raise MalformedTransform(conflicts=conflicts)
2636
def conflict_pass(tt, conflicts, path_tree=None):
2637
"""Resolve some classes of conflicts.
2639
:param tt: The transform to resolve conflicts in
2640
:param conflicts: The conflicts to resolve
2641
:param path_tree: A Tree to get supplemental paths from
2643
new_conflicts = set()
2644
for c_type, conflict in ((c[0], c) for c in conflicts):
2645
if c_type == 'duplicate id':
2646
tt.unversion_file(conflict[1])
2647
new_conflicts.add((c_type, 'Unversioned existing file',
2648
conflict[1], conflict[2], ))
2649
elif c_type == 'duplicate':
2650
# files that were renamed take precedence
2651
final_parent = tt.final_parent(conflict[1])
2652
if tt.path_changed(conflict[1]):
2653
existing_file, new_file = conflict[2], conflict[1]
2655
existing_file, new_file = conflict[1], conflict[2]
2656
new_name = tt.final_name(existing_file)+'.moved'
2657
tt.adjust_path(new_name, final_parent, existing_file)
2658
new_conflicts.add((c_type, 'Moved existing file to',
2659
existing_file, new_file))
2660
elif c_type == 'parent loop':
2661
# break the loop by undoing one of the ops that caused the loop
2663
while not tt.path_changed(cur):
2664
cur = tt.final_parent(cur)
2665
new_conflicts.add((c_type, 'Cancelled move', cur,
2666
tt.final_parent(cur),))
2667
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2669
elif c_type == 'missing parent':
2670
trans_id = conflict[1]
2672
tt.cancel_deletion(trans_id)
2673
new_conflicts.add(('deleting parent', 'Not deleting',
2678
tt.final_name(trans_id)
2680
if path_tree is not None:
2681
file_id = tt.final_file_id(trans_id)
2683
file_id = tt.inactive_file_id(trans_id)
2684
entry = path_tree.inventory[file_id]
2685
# special-case the other tree root (move its
2686
# children to current root)
2687
if entry.parent_id is None:
2689
moved = _reparent_transform_children(
2690
tt, trans_id, tt.root)
2692
new_conflicts.add((c_type, 'Moved to root',
2695
parent_trans_id = tt.trans_id_file_id(
2697
tt.adjust_path(entry.name, parent_trans_id,
2700
tt.create_directory(trans_id)
2701
new_conflicts.add((c_type, 'Created directory', trans_id))
2702
elif c_type == 'unversioned parent':
2703
file_id = tt.inactive_file_id(conflict[1])
2704
# special-case the other tree root (move its children instead)
2705
if path_tree and file_id in path_tree:
2706
if path_tree.inventory[file_id].parent_id is None:
2708
tt.version_file(file_id, conflict[1])
2709
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2710
elif c_type == 'non-directory parent':
2711
parent_id = conflict[1]
2712
parent_parent = tt.final_parent(parent_id)
2713
parent_name = tt.final_name(parent_id)
2714
parent_file_id = tt.final_file_id(parent_id)
2715
new_parent_id = tt.new_directory(parent_name + '.new',
2716
parent_parent, parent_file_id)
2717
_reparent_transform_children(tt, parent_id, new_parent_id)
2718
if parent_file_id is not None:
2719
tt.unversion_file(parent_id)
2720
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2721
elif c_type == 'versioning no contents':
2722
tt.cancel_versioning(conflict[1])
2723
return new_conflicts
2726
def cook_conflicts(raw_conflicts, tt):
2727
"""Generate a list of cooked conflicts, sorted by file path"""
2728
from bzrlib.conflicts import Conflict
2729
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2730
return sorted(conflict_iter, key=Conflict.sort_key)
2733
def iter_cook_conflicts(raw_conflicts, tt):
2734
from bzrlib.conflicts import Conflict
2736
for conflict in raw_conflicts:
2737
c_type = conflict[0]
2738
action = conflict[1]
2739
modified_path = fp.get_path(conflict[2])
2740
modified_id = tt.final_file_id(conflict[2])
2741
if len(conflict) == 3:
2742
yield Conflict.factory(c_type, action=action, path=modified_path,
2743
file_id=modified_id)
2746
conflicting_path = fp.get_path(conflict[3])
2747
conflicting_id = tt.final_file_id(conflict[3])
2748
yield Conflict.factory(c_type, action=action, path=modified_path,
2749
file_id=modified_id,
2750
conflict_path=conflicting_path,
2751
conflict_file_id=conflicting_id)
2754
class _FileMover(object):
2755
"""Moves and deletes files for TreeTransform, tracking operations"""
2758
self.past_renames = []
2759
self.pending_deletions = []
2761
def rename(self, from_, to):
2762
"""Rename a file from one path to another. Functions like os.rename"""
2764
os.rename(from_, to)
2766
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2767
raise errors.FileExists(to, str(e))
2769
self.past_renames.append((from_, to))
2771
def pre_delete(self, from_, to):
2772
"""Rename a file out of the way and mark it for deletion.
2774
Unlike os.unlink, this works equally well for files and directories.
2775
:param from_: The current file path
2776
:param to: A temporary path for the file
2778
self.rename(from_, to)
2779
self.pending_deletions.append(to)
2782
"""Reverse all renames that have been performed"""
2783
for from_, to in reversed(self.past_renames):
2784
os.rename(to, from_)
2785
# after rollback, don't reuse _FileMover
2787
pending_deletions = None
2789
def apply_deletions(self):
2790
"""Apply all marked deletions"""
2791
for path in self.pending_deletions:
2793
# after apply_deletions, don't reuse _FileMover
2795
pending_deletions = None
added
removed
bzrlib/transform.py
