1
# Copyright (C) 2006-2010 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
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
33
revision as _mod_revision,
36
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
37
ReusingTransform, NotVersionedError, CantMoveRoot,
38
ExistingLimbo, ImmortalLimbo, NoFinalPath,
40
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
41
from bzrlib.inventory import InventoryEntry
42
from bzrlib.osutils import (
52
from bzrlib.progress import DummyProgress, ProgressPhase
53
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, warning
58
from bzrlib import tree
60
import bzrlib.urlutils as urlutils
63
ROOT_PARENT = "root-parent"
66
def unique_add(map, key, value):
68
raise DuplicateKey(key=key)
72
class _TransformResults(object):
73
def __init__(self, modified_paths, rename_count):
75
self.modified_paths = modified_paths
76
self.rename_count = rename_count
79
class TreeTransformBase(object):
80
"""The base class for TreeTransform and its kin."""
82
def __init__(self, tree, pb=DummyProgress(),
86
:param tree: The tree that will be transformed, but not necessarily
88
:param pb: A ProgressTask indicating how much progress is being made
89
:param case_sensitive: If True, the target of the transform is
90
case sensitive, not just case preserving.
95
# mapping of trans_id -> new basename
97
# mapping of trans_id -> new parent trans_id
99
# mapping of trans_id with new contents -> new file_kind
100
self._new_contents = {}
101
# Set of trans_ids whose contents will be removed
102
self._removed_contents = set()
103
# Mapping of trans_id -> new execute-bit value
104
self._new_executability = {}
105
# Mapping of trans_id -> new tree-reference value
106
self._new_reference_revision = {}
107
# Mapping of trans_id -> new file_id
109
# Mapping of old file-id -> trans_id
110
self._non_present_ids = {}
111
# Mapping of new file_id -> trans_id
113
# Set of trans_ids that will be removed
114
self._removed_id = set()
115
# Mapping of path in old tree -> trans_id
116
self._tree_path_ids = {}
117
# Mapping trans_id -> path in old tree
118
self._tree_id_paths = {}
119
# The trans_id that will be used as the tree root
120
root_id = tree.get_root_id()
121
if root_id is not None:
122
self._new_root = self.trans_id_tree_file_id(root_id)
124
self._new_root = None
125
# Indictor of whether the transform has been applied
129
# Whether the target is case sensitive
130
self._case_sensitive_target = case_sensitive
131
# A counter of how many files have been renamed
132
self.rename_count = 0
135
"""Release the working tree lock, if held.
137
This is required if apply has not been invoked, but can be invoked
140
if self._tree is None:
145
def __get_root(self):
146
return self._new_root
148
root = property(__get_root)
150
def _assign_id(self):
151
"""Produce a new tranform id"""
152
new_id = "new-%s" % self._id_number
156
def create_path(self, name, parent):
157
"""Assign a transaction id to a new path"""
158
trans_id = self._assign_id()
159
unique_add(self._new_name, trans_id, name)
160
unique_add(self._new_parent, trans_id, parent)
163
def adjust_path(self, name, parent, trans_id):
164
"""Change the path that is assigned to a transaction id."""
166
raise ValueError("Parent trans-id may not be None")
167
if trans_id == self._new_root:
169
self._new_name[trans_id] = name
170
self._new_parent[trans_id] = parent
172
def adjust_root_path(self, name, parent):
173
"""Emulate moving the root by moving all children, instead.
175
We do this by undoing the association of root's transaction id with the
176
current tree. This allows us to create a new directory with that
177
transaction id. We unversion the root directory and version the
178
physically new directory, and hope someone versions the tree root
181
old_root = self._new_root
182
old_root_file_id = self.final_file_id(old_root)
183
# force moving all children of root
184
for child_id in self.iter_tree_children(old_root):
185
if child_id != parent:
186
self.adjust_path(self.final_name(child_id),
187
self.final_parent(child_id), child_id)
188
file_id = self.final_file_id(child_id)
189
if file_id is not None:
190
self.unversion_file(child_id)
191
self.version_file(file_id, child_id)
193
# the physical root needs a new transaction id
194
self._tree_path_ids.pop("")
195
self._tree_id_paths.pop(old_root)
196
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
197
if parent == old_root:
198
parent = self._new_root
199
self.adjust_path(name, parent, old_root)
200
self.create_directory(old_root)
201
self.version_file(old_root_file_id, old_root)
202
self.unversion_file(self._new_root)
204
def fixup_new_roots(self):
205
"""Reinterpret requests to change the root directory
207
Instead of creating a root directory, or moving an existing directory,
208
all the attributes and children of the new root are applied to the
209
existing root directory.
211
This means that the old root trans-id becomes obsolete, so it is
212
recommended only to invoke this after the root trans-id has become
215
new_roots = [k for k, v in self._new_parent.iteritems() if v is
217
if len(new_roots) < 1:
219
if len(new_roots) != 1:
220
raise ValueError('A tree cannot have two roots!')
221
if self._new_root is None:
222
self._new_root = new_roots[0]
224
old_new_root = new_roots[0]
225
# TODO: What to do if a old_new_root is present, but self._new_root is
226
# not listed as being removed? This code explicitly unversions
227
# the old root and versions it with the new file_id. Though that
228
# seems like an incomplete delta
230
# unversion the new root's directory.
231
file_id = self.final_file_id(old_new_root)
232
if old_new_root in self._new_id:
233
self.cancel_versioning(old_new_root)
235
self.unversion_file(old_new_root)
236
# if, at this stage, root still has an old file_id, zap it so we can
237
# stick a new one in.
238
if (self.tree_file_id(self._new_root) is not None and
239
self._new_root not in self._removed_id):
240
self.unversion_file(self._new_root)
241
self.version_file(file_id, self._new_root)
243
# Now move children of new root into old root directory.
244
# Ensure all children are registered with the transaction, but don't
245
# use directly-- some tree children have new parents
246
list(self.iter_tree_children(old_new_root))
247
# Move all children of new root into old root directory.
248
for child in self.by_parent().get(old_new_root, []):
249
self.adjust_path(self.final_name(child), self._new_root, child)
251
# Ensure old_new_root has no directory.
252
if old_new_root in self._new_contents:
253
self.cancel_creation(old_new_root)
255
self.delete_contents(old_new_root)
257
# prevent deletion of root directory.
258
if self._new_root in self._removed_contents:
259
self.cancel_deletion(self._new_root)
261
# destroy path info for old_new_root.
262
del self._new_parent[old_new_root]
263
del self._new_name[old_new_root]
265
def trans_id_tree_file_id(self, inventory_id):
266
"""Determine the transaction id of a working tree file.
268
This reflects only files that already exist, not ones that will be
269
added by transactions.
271
if inventory_id is None:
272
raise ValueError('None is not a valid file id')
273
path = self._tree.id2path(inventory_id)
274
return self.trans_id_tree_path(path)
276
def trans_id_file_id(self, file_id):
277
"""Determine or set the transaction id associated with a file ID.
278
A new id is only created for file_ids that were never present. If
279
a transaction has been unversioned, it is deliberately still returned.
280
(this will likely lead to an unversioned parent conflict.)
283
raise ValueError('None is not a valid file id')
284
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
285
return self._r_new_id[file_id]
288
self._tree.iter_entries_by_dir([file_id]).next()
289
except StopIteration:
290
if file_id in self._non_present_ids:
291
return self._non_present_ids[file_id]
293
trans_id = self._assign_id()
294
self._non_present_ids[file_id] = trans_id
297
return self.trans_id_tree_file_id(file_id)
299
def trans_id_tree_path(self, path):
300
"""Determine (and maybe set) the transaction ID for a tree path."""
301
path = self.canonical_path(path)
302
if path not in self._tree_path_ids:
303
self._tree_path_ids[path] = self._assign_id()
304
self._tree_id_paths[self._tree_path_ids[path]] = path
305
return self._tree_path_ids[path]
307
def get_tree_parent(self, trans_id):
308
"""Determine id of the parent in the tree."""
309
path = self._tree_id_paths[trans_id]
312
return self.trans_id_tree_path(os.path.dirname(path))
314
def delete_contents(self, trans_id):
315
"""Schedule the contents of a path entry for deletion"""
316
# Ensure that the object exists in the WorkingTree, this will raise an
317
# exception if there is a problem
318
self.tree_kind(trans_id)
319
self._removed_contents.add(trans_id)
321
def cancel_deletion(self, trans_id):
322
"""Cancel a scheduled deletion"""
323
self._removed_contents.remove(trans_id)
325
def unversion_file(self, trans_id):
326
"""Schedule a path entry to become unversioned"""
327
self._removed_id.add(trans_id)
329
def delete_versioned(self, trans_id):
330
"""Delete and unversion a versioned file"""
331
self.delete_contents(trans_id)
332
self.unversion_file(trans_id)
334
def set_executability(self, executability, trans_id):
335
"""Schedule setting of the 'execute' bit
336
To unschedule, set to None
338
if executability is None:
339
del self._new_executability[trans_id]
341
unique_add(self._new_executability, trans_id, executability)
343
def set_tree_reference(self, revision_id, trans_id):
344
"""Set the reference associated with a directory"""
345
unique_add(self._new_reference_revision, trans_id, revision_id)
347
def version_file(self, file_id, trans_id):
348
"""Schedule a file to become versioned."""
351
unique_add(self._new_id, trans_id, file_id)
352
unique_add(self._r_new_id, file_id, trans_id)
354
def cancel_versioning(self, trans_id):
355
"""Undo a previous versioning of a file"""
356
file_id = self._new_id[trans_id]
357
del self._new_id[trans_id]
358
del self._r_new_id[file_id]
360
def new_paths(self, filesystem_only=False):
361
"""Determine the paths of all new and changed files.
363
:param filesystem_only: if True, only calculate values for files
364
that require renames or execute bit changes.
368
stale_ids = self._needs_rename.difference(self._new_name)
369
stale_ids.difference_update(self._new_parent)
370
stale_ids.difference_update(self._new_contents)
371
stale_ids.difference_update(self._new_id)
372
needs_rename = self._needs_rename.difference(stale_ids)
373
id_sets = (needs_rename, self._new_executability)
375
id_sets = (self._new_name, self._new_parent, self._new_contents,
376
self._new_id, self._new_executability)
377
for id_set in id_sets:
378
new_ids.update(id_set)
379
return sorted(FinalPaths(self).get_paths(new_ids))
381
def _inventory_altered(self):
382
"""Get the trans_ids and paths of files needing new inv entries."""
384
for id_set in [self._new_name, self._new_parent, self._new_id,
385
self._new_executability]:
386
new_ids.update(id_set)
387
changed_kind = set(self._removed_contents)
388
changed_kind.intersection_update(self._new_contents)
389
changed_kind.difference_update(new_ids)
390
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
392
new_ids.update(changed_kind)
393
return sorted(FinalPaths(self).get_paths(new_ids))
395
def final_kind(self, trans_id):
396
"""Determine the final file kind, after any changes applied.
398
Raises NoSuchFile if the file does not exist/has no contents.
399
(It is conceivable that a path would be created without the
400
corresponding contents insertion command)
402
if trans_id in self._new_contents:
403
return self._new_contents[trans_id]
404
elif trans_id in self._removed_contents:
405
raise NoSuchFile(None)
407
return self.tree_kind(trans_id)
409
def tree_file_id(self, trans_id):
410
"""Determine the file id associated with the trans_id in the tree"""
412
path = self._tree_id_paths[trans_id]
414
# the file is a new, unversioned file, or invalid trans_id
416
# the file is old; the old id is still valid
417
if self._new_root == trans_id:
418
return self._tree.get_root_id()
419
return self._tree.path2id(path)
421
def final_file_id(self, trans_id):
422
"""Determine the file id after any changes are applied, or None.
424
None indicates that the file will not be versioned after changes are
428
return self._new_id[trans_id]
430
if trans_id in self._removed_id:
432
return self.tree_file_id(trans_id)
434
def inactive_file_id(self, trans_id):
435
"""Return the inactive file_id associated with a transaction id.
436
That is, the one in the tree or in non_present_ids.
437
The file_id may actually be active, too.
439
file_id = self.tree_file_id(trans_id)
440
if file_id is not None:
442
for key, value in self._non_present_ids.iteritems():
443
if value == trans_id:
446
def final_parent(self, trans_id):
447
"""Determine the parent file_id, after any changes are applied.
449
ROOT_PARENT is returned for the tree root.
452
return self._new_parent[trans_id]
454
return self.get_tree_parent(trans_id)
456
def final_name(self, trans_id):
457
"""Determine the final filename, after all changes are applied."""
459
return self._new_name[trans_id]
462
return os.path.basename(self._tree_id_paths[trans_id])
464
raise NoFinalPath(trans_id, self)
467
"""Return a map of parent: children for known parents.
469
Only new paths and parents of tree files with assigned ids are used.
472
items = list(self._new_parent.iteritems())
473
items.extend((t, self.final_parent(t)) for t in
474
self._tree_id_paths.keys())
475
for trans_id, parent_id in items:
476
if parent_id not in by_parent:
477
by_parent[parent_id] = set()
478
by_parent[parent_id].add(trans_id)
481
def path_changed(self, trans_id):
482
"""Return True if a trans_id's path has changed."""
483
return (trans_id in self._new_name) or (trans_id in self._new_parent)
485
def new_contents(self, trans_id):
486
return (trans_id in self._new_contents)
488
def find_conflicts(self):
489
"""Find any violations of inventory or filesystem invariants"""
490
if self._done is True:
491
raise ReusingTransform()
493
# ensure all children of all existent parents are known
494
# all children of non-existent parents are known, by definition.
495
self._add_tree_children()
496
by_parent = self.by_parent()
497
conflicts.extend(self._unversioned_parents(by_parent))
498
conflicts.extend(self._parent_loops())
499
conflicts.extend(self._duplicate_entries(by_parent))
500
conflicts.extend(self._duplicate_ids())
501
conflicts.extend(self._parent_type_conflicts(by_parent))
502
conflicts.extend(self._improper_versioning())
503
conflicts.extend(self._executability_conflicts())
504
conflicts.extend(self._overwrite_conflicts())
507
def _check_malformed(self):
508
conflicts = self.find_conflicts()
509
if len(conflicts) != 0:
510
raise MalformedTransform(conflicts=conflicts)
512
def _add_tree_children(self):
513
"""Add all the children of all active parents to the known paths.
515
Active parents are those which gain children, and those which are
516
removed. This is a necessary first step in detecting conflicts.
518
parents = self.by_parent().keys()
519
parents.extend([t for t in self._removed_contents if
520
self.tree_kind(t) == 'directory'])
521
for trans_id in self._removed_id:
522
file_id = self.tree_file_id(trans_id)
523
if file_id is not None:
524
if self._tree.inventory[file_id].kind == 'directory':
525
parents.append(trans_id)
526
elif self.tree_kind(trans_id) == 'directory':
527
parents.append(trans_id)
529
for parent_id in parents:
530
# ensure that all children are registered with the transaction
531
list(self.iter_tree_children(parent_id))
533
def has_named_child(self, by_parent, parent_id, name):
535
children = by_parent[parent_id]
538
for child in children:
539
if self.final_name(child) == name:
542
path = self._tree_id_paths[parent_id]
545
childpath = joinpath(path, name)
546
child_id = self._tree_path_ids.get(childpath)
548
return lexists(self._tree.abspath(childpath))
550
if self.final_parent(child_id) != parent_id:
552
if child_id in self._removed_contents:
553
# XXX What about dangling file-ids?
558
def _parent_loops(self):
559
"""No entry should be its own ancestor"""
561
for trans_id in self._new_parent:
564
while parent_id is not ROOT_PARENT:
567
parent_id = self.final_parent(parent_id)
570
if parent_id == trans_id:
571
conflicts.append(('parent loop', trans_id))
572
if parent_id in seen:
576
def _unversioned_parents(self, by_parent):
577
"""If parent directories are versioned, children must be versioned."""
579
for parent_id, children in by_parent.iteritems():
580
if parent_id is ROOT_PARENT:
582
if self.final_file_id(parent_id) is not None:
584
for child_id in children:
585
if self.final_file_id(child_id) is not None:
586
conflicts.append(('unversioned parent', parent_id))
590
def _improper_versioning(self):
591
"""Cannot version a file with no contents, or a bad type.
593
However, existing entries with no contents are okay.
596
for trans_id in self._new_id.iterkeys():
598
kind = self.final_kind(trans_id)
600
conflicts.append(('versioning no contents', trans_id))
602
if not InventoryEntry.versionable_kind(kind):
603
conflicts.append(('versioning bad kind', trans_id, kind))
606
def _executability_conflicts(self):
607
"""Check for bad executability changes.
609
Only versioned files may have their executability set, because
610
1. only versioned entries can have executability under windows
611
2. only files can be executable. (The execute bit on a directory
612
does not indicate searchability)
615
for trans_id in self._new_executability:
616
if self.final_file_id(trans_id) is None:
617
conflicts.append(('unversioned executability', trans_id))
620
non_file = self.final_kind(trans_id) != "file"
624
conflicts.append(('non-file executability', trans_id))
627
def _overwrite_conflicts(self):
628
"""Check for overwrites (not permitted on Win32)"""
630
for trans_id in self._new_contents:
632
self.tree_kind(trans_id)
635
if trans_id not in self._removed_contents:
636
conflicts.append(('overwrite', trans_id,
637
self.final_name(trans_id)))
640
def _duplicate_entries(self, by_parent):
641
"""No directory may have two entries with the same name."""
643
if (self._new_name, self._new_parent) == ({}, {}):
645
for children in by_parent.itervalues():
646
name_ids = [(self.final_name(t), t) for t in children]
647
if not self._case_sensitive_target:
648
name_ids = [(n.lower(), t) for n, t in name_ids]
652
for name, trans_id in name_ids:
654
kind = self.final_kind(trans_id)
657
file_id = self.final_file_id(trans_id)
658
if kind is None and file_id is None:
660
if name == last_name:
661
conflicts.append(('duplicate', last_trans_id, trans_id,
664
last_trans_id = trans_id
667
def _duplicate_ids(self):
668
"""Each inventory id may only be used once"""
670
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
672
all_ids = self._tree.all_file_ids()
673
active_tree_ids = all_ids.difference(removed_tree_ids)
674
for trans_id, file_id in self._new_id.iteritems():
675
if file_id in active_tree_ids:
676
old_trans_id = self.trans_id_tree_file_id(file_id)
677
conflicts.append(('duplicate id', old_trans_id, trans_id))
680
def _parent_type_conflicts(self, by_parent):
681
"""parents must have directory 'contents'."""
683
for parent_id, children in by_parent.iteritems():
684
if parent_id is ROOT_PARENT:
686
if not self._any_contents(children):
688
for child in children:
690
self.final_kind(child)
694
kind = self.final_kind(parent_id)
698
conflicts.append(('missing parent', parent_id))
699
elif kind != "directory":
700
conflicts.append(('non-directory parent', parent_id))
703
def _any_contents(self, trans_ids):
704
"""Return true if any of the trans_ids, will have contents."""
705
for trans_id in trans_ids:
707
kind = self.final_kind(trans_id)
713
def _set_executability(self, path, trans_id):
714
"""Set the executability of versioned files """
715
if supports_executable():
716
new_executability = self._new_executability[trans_id]
717
abspath = self._tree.abspath(path)
718
current_mode = os.stat(abspath).st_mode
719
if new_executability:
722
to_mode = current_mode | (0100 & ~umask)
723
# Enable x-bit for others only if they can read it.
724
if current_mode & 0004:
725
to_mode |= 0001 & ~umask
726
if current_mode & 0040:
727
to_mode |= 0010 & ~umask
729
to_mode = current_mode & ~0111
730
os.chmod(abspath, to_mode)
732
def _new_entry(self, name, parent_id, file_id):
733
"""Helper function to create a new filesystem entry."""
734
trans_id = self.create_path(name, parent_id)
735
if file_id is not None:
736
self.version_file(file_id, trans_id)
739
def new_file(self, name, parent_id, contents, file_id=None,
741
"""Convenience method to create files.
743
name is the name of the file to create.
744
parent_id is the transaction id of the parent directory of the file.
745
contents is an iterator of bytestrings, which will be used to produce
747
:param file_id: The inventory ID of the file, if it is to be versioned.
748
:param executable: Only valid when a file_id has been supplied.
750
trans_id = self._new_entry(name, parent_id, file_id)
751
# TODO: rather than scheduling a set_executable call,
752
# have create_file create the file with the right mode.
753
self.create_file(contents, trans_id)
754
if executable is not None:
755
self.set_executability(executable, trans_id)
758
def new_directory(self, name, parent_id, file_id=None):
759
"""Convenience method to create directories.
761
name is the name of the directory to create.
762
parent_id is the transaction id of the parent directory of the
764
file_id is the inventory ID of the directory, if it is to be versioned.
766
trans_id = self._new_entry(name, parent_id, file_id)
767
self.create_directory(trans_id)
770
def new_symlink(self, name, parent_id, target, file_id=None):
771
"""Convenience method to create symbolic link.
773
name is the name of the symlink to create.
774
parent_id is the transaction id of the parent directory of the symlink.
775
target is a bytestring of the target of the symlink.
776
file_id is the inventory ID of the file, if it is to be versioned.
778
trans_id = self._new_entry(name, parent_id, file_id)
779
self.create_symlink(target, trans_id)
782
def _affected_ids(self):
783
"""Return the set of transform ids affected by the transform"""
784
trans_ids = set(self._removed_id)
785
trans_ids.update(self._new_id.keys())
786
trans_ids.update(self._removed_contents)
787
trans_ids.update(self._new_contents.keys())
788
trans_ids.update(self._new_executability.keys())
789
trans_ids.update(self._new_name.keys())
790
trans_ids.update(self._new_parent.keys())
793
def _get_file_id_maps(self):
794
"""Return mapping of file_ids to trans_ids in the to and from states"""
795
trans_ids = self._affected_ids()
798
# Build up two dicts: trans_ids associated with file ids in the
799
# FROM state, vs the TO state.
800
for trans_id in trans_ids:
801
from_file_id = self.tree_file_id(trans_id)
802
if from_file_id is not None:
803
from_trans_ids[from_file_id] = trans_id
804
to_file_id = self.final_file_id(trans_id)
805
if to_file_id is not None:
806
to_trans_ids[to_file_id] = trans_id
807
return from_trans_ids, to_trans_ids
809
def _from_file_data(self, from_trans_id, from_versioned, file_id):
810
"""Get data about a file in the from (tree) state
812
Return a (name, parent, kind, executable) tuple
814
from_path = self._tree_id_paths.get(from_trans_id)
816
# get data from working tree if versioned
817
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
818
from_name = from_entry.name
819
from_parent = from_entry.parent_id
822
if from_path is None:
823
# File does not exist in FROM state
827
# File exists, but is not versioned. Have to use path-
829
from_name = os.path.basename(from_path)
830
tree_parent = self.get_tree_parent(from_trans_id)
831
from_parent = self.tree_file_id(tree_parent)
832
if from_path is not None:
833
from_kind, from_executable, from_stats = \
834
self._tree._comparison_data(from_entry, from_path)
837
from_executable = False
838
return from_name, from_parent, from_kind, from_executable
840
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
841
"""Get data about a file in the to (target) state
843
Return a (name, parent, kind, executable) tuple
845
to_name = self.final_name(to_trans_id)
847
to_kind = self.final_kind(to_trans_id)
850
to_parent = self.final_file_id(self.final_parent(to_trans_id))
851
if to_trans_id in self._new_executability:
852
to_executable = self._new_executability[to_trans_id]
853
elif to_trans_id == from_trans_id:
854
to_executable = from_executable
856
to_executable = False
857
return to_name, to_parent, to_kind, to_executable
859
def iter_changes(self):
860
"""Produce output in the same format as Tree.iter_changes.
862
Will produce nonsensical results if invoked while inventory/filesystem
863
conflicts (as reported by TreeTransform.find_conflicts()) are present.
865
This reads the Transform, but only reproduces changes involving a
866
file_id. Files that are not versioned in either of the FROM or TO
867
states are not reflected.
869
final_paths = FinalPaths(self)
870
from_trans_ids, to_trans_ids = self._get_file_id_maps()
872
# Now iterate through all active file_ids
873
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
875
from_trans_id = from_trans_ids.get(file_id)
876
# find file ids, and determine versioning state
877
if from_trans_id is None:
878
from_versioned = False
879
from_trans_id = to_trans_ids[file_id]
881
from_versioned = True
882
to_trans_id = to_trans_ids.get(file_id)
883
if to_trans_id is None:
885
to_trans_id = from_trans_id
889
from_name, from_parent, from_kind, from_executable = \
890
self._from_file_data(from_trans_id, from_versioned, file_id)
892
to_name, to_parent, to_kind, to_executable = \
893
self._to_file_data(to_trans_id, from_trans_id, from_executable)
895
if not from_versioned:
898
from_path = self._tree_id_paths.get(from_trans_id)
902
to_path = final_paths.get_path(to_trans_id)
903
if from_kind != to_kind:
905
elif to_kind in ('file', 'symlink') and (
906
to_trans_id != from_trans_id or
907
to_trans_id in self._new_contents):
909
if (not modified and from_versioned == to_versioned and
910
from_parent==to_parent and from_name == to_name and
911
from_executable == to_executable):
913
results.append((file_id, (from_path, to_path), modified,
914
(from_versioned, to_versioned),
915
(from_parent, to_parent),
916
(from_name, to_name),
917
(from_kind, to_kind),
918
(from_executable, to_executable)))
919
return iter(sorted(results, key=lambda x:x[1]))
921
def get_preview_tree(self):
922
"""Return a tree representing the result of the transform.
924
The tree is a snapshot, and altering the TreeTransform will invalidate
927
return _PreviewTree(self)
929
def commit(self, branch, message, merge_parents=None, strict=False):
930
"""Commit the result of this TreeTransform to a branch.
932
:param branch: The branch to commit to.
933
:param message: The message to attach to the commit.
934
:param merge_parents: Additional parents specified by pending merges.
935
:return: The revision_id of the revision committed.
937
self._check_malformed()
939
unversioned = set(self._new_contents).difference(set(self._new_id))
940
for trans_id in unversioned:
941
if self.final_file_id(trans_id) is None:
942
raise errors.StrictCommitFailed()
944
revno, last_rev_id = branch.last_revision_info()
945
if last_rev_id == _mod_revision.NULL_REVISION:
946
if merge_parents is not None:
947
raise ValueError('Cannot supply merge parents for first'
951
parent_ids = [last_rev_id]
952
if merge_parents is not None:
953
parent_ids.extend(merge_parents)
954
if self._tree.get_revision_id() != last_rev_id:
955
raise ValueError('TreeTransform not based on branch basis: %s' %
956
self._tree.get_revision_id())
957
builder = branch.get_commit_builder(parent_ids)
958
preview = self.get_preview_tree()
959
list(builder.record_iter_changes(preview, last_rev_id,
960
self.iter_changes()))
961
builder.finish_inventory()
962
revision_id = builder.commit(message)
963
branch.set_last_revision_info(revno + 1, revision_id)
966
def _text_parent(self, trans_id):
967
file_id = self.tree_file_id(trans_id)
969
if file_id is None or self._tree.kind(file_id) != 'file':
971
except errors.NoSuchFile:
975
def _get_parents_texts(self, trans_id):
976
"""Get texts for compression parents of this file."""
977
file_id = self._text_parent(trans_id)
980
return (self._tree.get_file_text(file_id),)
982
def _get_parents_lines(self, trans_id):
983
"""Get lines for compression parents of this file."""
984
file_id = self._text_parent(trans_id)
987
return (self._tree.get_file_lines(file_id),)
989
def serialize(self, serializer):
990
"""Serialize this TreeTransform.
992
:param serializer: A Serialiser like pack.ContainerSerializer.
994
new_name = dict((k, v.encode('utf-8')) for k, v in
995
self._new_name.items())
996
new_executability = dict((k, int(v)) for k, v in
997
self._new_executability.items())
998
tree_path_ids = dict((k.encode('utf-8'), v)
999
for k, v in self._tree_path_ids.items())
1001
'_id_number': self._id_number,
1002
'_new_name': new_name,
1003
'_new_parent': self._new_parent,
1004
'_new_executability': new_executability,
1005
'_new_id': self._new_id,
1006
'_tree_path_ids': tree_path_ids,
1007
'_removed_id': list(self._removed_id),
1008
'_removed_contents': list(self._removed_contents),
1009
'_non_present_ids': self._non_present_ids,
1011
yield serializer.bytes_record(bencode.bencode(attribs),
1013
for trans_id, kind in self._new_contents.items():
1015
lines = osutils.chunks_to_lines(
1016
self._read_file_chunks(trans_id))
1017
parents = self._get_parents_lines(trans_id)
1018
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1019
content = ''.join(mpdiff.to_patch())
1020
if kind == 'directory':
1022
if kind == 'symlink':
1023
content = self._read_symlink_target(trans_id)
1024
yield serializer.bytes_record(content, ((trans_id, kind),))
1026
def deserialize(self, records):
1027
"""Deserialize a stored TreeTransform.
1029
:param records: An iterable of (names, content) tuples, as per
1030
pack.ContainerPushParser.
1032
names, content = records.next()
1033
attribs = bencode.bdecode(content)
1034
self._id_number = attribs['_id_number']
1035
self._new_name = dict((k, v.decode('utf-8'))
1036
for k, v in attribs['_new_name'].items())
1037
self._new_parent = attribs['_new_parent']
1038
self._new_executability = dict((k, bool(v)) for k, v in
1039
attribs['_new_executability'].items())
1040
self._new_id = attribs['_new_id']
1041
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1042
self._tree_path_ids = {}
1043
self._tree_id_paths = {}
1044
for bytepath, trans_id in attribs['_tree_path_ids'].items():
1045
path = bytepath.decode('utf-8')
1046
self._tree_path_ids[path] = trans_id
1047
self._tree_id_paths[trans_id] = path
1048
self._removed_id = set(attribs['_removed_id'])
1049
self._removed_contents = set(attribs['_removed_contents'])
1050
self._non_present_ids = attribs['_non_present_ids']
1051
for ((trans_id, kind),), content in records:
1053
mpdiff = multiparent.MultiParent.from_patch(content)
1054
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1055
self.create_file(lines, trans_id)
1056
if kind == 'directory':
1057
self.create_directory(trans_id)
1058
if kind == 'symlink':
1059
self.create_symlink(content.decode('utf-8'), trans_id)
1062
class DiskTreeTransform(TreeTransformBase):
1063
"""Tree transform storing its contents on disk."""
1065
def __init__(self, tree, limbodir, pb=DummyProgress(),
1066
case_sensitive=True):
1068
:param tree: The tree that will be transformed, but not necessarily
1070
:param limbodir: A directory where new files can be stored until
1071
they are installed in their proper places
1072
:param pb: A ProgressBar indicating how much progress is being made
1073
:param case_sensitive: If True, the target of the transform is
1074
case sensitive, not just case preserving.
1076
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1077
self._limbodir = limbodir
1078
self._deletiondir = None
1079
# A mapping of transform ids to their limbo filename
1080
self._limbo_files = {}
1081
# A mapping of transform ids to a set of the transform ids of children
1082
# that their limbo directory has
1083
self._limbo_children = {}
1084
# Map transform ids to maps of child filename to child transform id
1085
self._limbo_children_names = {}
1086
# List of transform ids that need to be renamed from limbo into place
1087
self._needs_rename = set()
1088
self._creation_mtime = None
1091
"""Release the working tree lock, if held, clean up limbo dir.
1093
This is required if apply has not been invoked, but can be invoked
1096
if self._tree is None:
1099
entries = [(self._limbo_name(t), t, k) for t, k in
1100
self._new_contents.iteritems()]
1101
entries.sort(reverse=True)
1102
for path, trans_id, kind in entries:
1105
delete_any(self._limbodir)
1107
# We don't especially care *why* the dir is immortal.
1108
raise ImmortalLimbo(self._limbodir)
1110
if self._deletiondir is not None:
1111
delete_any(self._deletiondir)
1113
raise errors.ImmortalPendingDeletion(self._deletiondir)
1115
TreeTransformBase.finalize(self)
1117
def _limbo_name(self, trans_id):
1118
"""Generate the limbo name of a file"""
1119
limbo_name = self._limbo_files.get(trans_id)
1120
if limbo_name is None:
1121
limbo_name = self._generate_limbo_path(trans_id)
1122
self._limbo_files[trans_id] = limbo_name
1125
def _generate_limbo_path(self, trans_id):
1126
"""Generate a limbo path using the trans_id as the relative path.
1128
This is suitable as a fallback, and when the transform should not be
1129
sensitive to the path encoding of the limbo directory.
1131
self._needs_rename.add(trans_id)
1132
return pathjoin(self._limbodir, trans_id)
1134
def adjust_path(self, name, parent, trans_id):
1135
previous_parent = self._new_parent.get(trans_id)
1136
previous_name = self._new_name.get(trans_id)
1137
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1138
if (trans_id in self._limbo_files and
1139
trans_id not in self._needs_rename):
1140
self._rename_in_limbo([trans_id])
1141
if previous_parent != parent:
1142
self._limbo_children[previous_parent].remove(trans_id)
1143
if previous_parent != parent or previous_name != name:
1144
del self._limbo_children_names[previous_parent][previous_name]
1146
def _rename_in_limbo(self, trans_ids):
1147
"""Fix limbo names so that the right final path is produced.
1149
This means we outsmarted ourselves-- we tried to avoid renaming
1150
these files later by creating them with their final names in their
1151
final parents. But now the previous name or parent is no longer
1152
suitable, so we have to rename them.
1154
Even for trans_ids that have no new contents, we must remove their
1155
entries from _limbo_files, because they are now stale.
1157
for trans_id in trans_ids:
1158
old_path = self._limbo_files.pop(trans_id)
1159
if trans_id not in self._new_contents:
1161
new_path = self._limbo_name(trans_id)
1162
os.rename(old_path, new_path)
1163
for descendant in self._limbo_descendants(trans_id):
1164
desc_path = self._limbo_files[descendant]
1165
desc_path = new_path + desc_path[len(old_path):]
1166
self._limbo_files[descendant] = desc_path
1168
def _limbo_descendants(self, trans_id):
1169
"""Return the set of trans_ids whose limbo paths descend from this."""
1170
descendants = set(self._limbo_children.get(trans_id, []))
1171
for descendant in list(descendants):
1172
descendants.update(self._limbo_descendants(descendant))
1175
def create_file(self, contents, trans_id, mode_id=None):
1176
"""Schedule creation of a new file.
1180
Contents is an iterator of strings, all of which will be written
1181
to the target destination.
1183
New file takes the permissions of any existing file with that id,
1184
unless mode_id is specified.
1186
name = self._limbo_name(trans_id)
1187
f = open(name, 'wb')
1190
unique_add(self._new_contents, trans_id, 'file')
1192
# Clean up the file, it never got registered so
1193
# TreeTransform.finalize() won't clean it up.
1198
f.writelines(contents)
1201
self._set_mtime(name)
1202
self._set_mode(trans_id, mode_id, S_ISREG)
1204
def _read_file_chunks(self, trans_id):
1205
cur_file = open(self._limbo_name(trans_id), 'rb')
1207
return cur_file.readlines()
1211
def _read_symlink_target(self, trans_id):
1212
return os.readlink(self._limbo_name(trans_id))
1214
def _set_mtime(self, path):
1215
"""All files that are created get the same mtime.
1217
This time is set by the first object to be created.
1219
if self._creation_mtime is None:
1220
self._creation_mtime = time.time()
1221
os.utime(path, (self._creation_mtime, self._creation_mtime))
1223
def create_hardlink(self, path, trans_id):
1224
"""Schedule creation of a hard link"""
1225
name = self._limbo_name(trans_id)
1229
if e.errno != errno.EPERM:
1231
raise errors.HardLinkNotSupported(path)
1233
unique_add(self._new_contents, trans_id, 'file')
1235
# Clean up the file, it never got registered so
1236
# TreeTransform.finalize() won't clean it up.
1240
def create_directory(self, trans_id):
1241
"""Schedule creation of a new directory.
1243
See also new_directory.
1245
os.mkdir(self._limbo_name(trans_id))
1246
unique_add(self._new_contents, trans_id, 'directory')
1248
def create_symlink(self, target, trans_id):
1249
"""Schedule creation of a new symbolic link.
1251
target is a bytestring.
1252
See also new_symlink.
1255
os.symlink(target, self._limbo_name(trans_id))
1256
unique_add(self._new_contents, trans_id, 'symlink')
1259
path = FinalPaths(self).get_path(trans_id)
1262
raise UnableCreateSymlink(path=path)
1264
def cancel_creation(self, trans_id):
1265
"""Cancel the creation of new file contents."""
1266
del self._new_contents[trans_id]
1267
children = self._limbo_children.get(trans_id)
1268
# if this is a limbo directory with children, move them before removing
1270
if children is not None:
1271
self._rename_in_limbo(children)
1272
del self._limbo_children[trans_id]
1273
del self._limbo_children_names[trans_id]
1274
delete_any(self._limbo_name(trans_id))
1277
class TreeTransform(DiskTreeTransform):
1278
"""Represent a tree transformation.
1280
This object is designed to support incremental generation of the transform,
1283
However, it gives optimum performance when parent directories are created
1284
before their contents. The transform is then able to put child files
1285
directly in their parent directory, avoiding later renames.
1287
It is easy to produce malformed transforms, but they are generally
1288
harmless. Attempting to apply a malformed transform will cause an
1289
exception to be raised before any modifications are made to the tree.
1291
Many kinds of malformed transforms can be corrected with the
1292
resolve_conflicts function. The remaining ones indicate programming error,
1293
such as trying to create a file with no path.
1295
Two sets of file creation methods are supplied. Convenience methods are:
1300
These are composed of the low-level methods:
1302
* create_file or create_directory or create_symlink
1306
Transform/Transaction ids
1307
-------------------------
1308
trans_ids are temporary ids assigned to all files involved in a transform.
1309
It's possible, even common, that not all files in the Tree have trans_ids.
1311
trans_ids are used because filenames and file_ids are not good enough
1312
identifiers; filenames change, and not all files have file_ids. File-ids
1313
are also associated with trans-ids, so that moving a file moves its
1316
trans_ids are only valid for the TreeTransform that generated them.
1320
Limbo is a temporary directory use to hold new versions of files.
1321
Files are added to limbo by create_file, create_directory, create_symlink,
1322
and their convenience variants (new_*). Files may be removed from limbo
1323
using cancel_creation. Files are renamed from limbo into their final
1324
location as part of TreeTransform.apply
1326
Limbo must be cleaned up, by either calling TreeTransform.apply or
1327
calling TreeTransform.finalize.
1329
Files are placed into limbo inside their parent directories, where
1330
possible. This reduces subsequent renames, and makes operations involving
1331
lots of files faster. This optimization is only possible if the parent
1332
directory is created *before* creating any of its children, so avoid
1333
creating children before parents, where possible.
1337
This temporary directory is used by _FileMover for storing files that are
1338
about to be deleted. In case of rollback, the files will be restored.
1339
FileMover does not delete files until it is sure that a rollback will not
1342
def __init__(self, tree, pb=DummyProgress()):
1343
"""Note: a tree_write lock is taken on the tree.
1345
Use TreeTransform.finalize() to release the lock (can be omitted if
1346
TreeTransform.apply() called).
1348
tree.lock_tree_write()
1351
limbodir = urlutils.local_path_from_url(
1352
tree._transport.abspath('limbo'))
1356
if e.errno == errno.EEXIST:
1357
raise ExistingLimbo(limbodir)
1358
deletiondir = urlutils.local_path_from_url(
1359
tree._transport.abspath('pending-deletion'))
1361
os.mkdir(deletiondir)
1363
if e.errno == errno.EEXIST:
1364
raise errors.ExistingPendingDeletion(deletiondir)
1369
# Cache of realpath results, to speed up canonical_path
1370
self._realpaths = {}
1371
# Cache of relpath results, to speed up canonical_path
1373
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1374
tree.case_sensitive)
1375
self._deletiondir = deletiondir
1377
def canonical_path(self, path):
1378
"""Get the canonical tree-relative path"""
1379
# don't follow final symlinks
1380
abs = self._tree.abspath(path)
1381
if abs in self._relpaths:
1382
return self._relpaths[abs]
1383
dirname, basename = os.path.split(abs)
1384
if dirname not in self._realpaths:
1385
self._realpaths[dirname] = os.path.realpath(dirname)
1386
dirname = self._realpaths[dirname]
1387
abs = pathjoin(dirname, basename)
1388
if dirname in self._relpaths:
1389
relpath = pathjoin(self._relpaths[dirname], basename)
1390
relpath = relpath.rstrip('/\\')
1392
relpath = self._tree.relpath(abs)
1393
self._relpaths[abs] = relpath
1396
def tree_kind(self, trans_id):
1397
"""Determine the file kind in the working tree.
1399
Raises NoSuchFile if the file does not exist
1401
path = self._tree_id_paths.get(trans_id)
1403
raise NoSuchFile(None)
1405
return file_kind(self._tree.abspath(path))
1407
if e.errno != errno.ENOENT:
1410
raise NoSuchFile(path)
1412
def _set_mode(self, trans_id, mode_id, typefunc):
1413
"""Set the mode of new file contents.
1414
The mode_id is the existing file to get the mode from (often the same
1415
as trans_id). The operation is only performed if there's a mode match
1416
according to typefunc.
1421
old_path = self._tree_id_paths[mode_id]
1425
mode = os.stat(self._tree.abspath(old_path)).st_mode
1427
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1428
# Either old_path doesn't exist, or the parent of the
1429
# target is not a directory (but will be one eventually)
1430
# Either way, we know it doesn't exist *right now*
1431
# See also bug #248448
1436
os.chmod(self._limbo_name(trans_id), mode)
1438
def iter_tree_children(self, parent_id):
1439
"""Iterate through the entry's tree children, if any"""
1441
path = self._tree_id_paths[parent_id]
1445
children = os.listdir(self._tree.abspath(path))
1447
if not (osutils._is_error_enotdir(e)
1448
or e.errno in (errno.ENOENT, errno.ESRCH)):
1452
for child in children:
1453
childpath = joinpath(path, child)
1454
if self._tree.is_control_filename(childpath):
1456
yield self.trans_id_tree_path(childpath)
1458
def _generate_limbo_path(self, trans_id):
1459
"""Generate a limbo path using the final path if possible.
1461
This optimizes the performance of applying the tree transform by
1462
avoiding renames. These renames can be avoided only when the parent
1463
directory is already scheduled for creation.
1465
If the final path cannot be used, falls back to using the trans_id as
1468
parent = self._new_parent.get(trans_id)
1469
# if the parent directory is already in limbo (e.g. when building a
1470
# tree), choose a limbo name inside the parent, to reduce further
1472
use_direct_path = False
1473
if self._new_contents.get(parent) == 'directory':
1474
filename = self._new_name.get(trans_id)
1475
if filename is not None:
1476
if parent not in self._limbo_children:
1477
self._limbo_children[parent] = set()
1478
self._limbo_children_names[parent] = {}
1479
use_direct_path = True
1480
# the direct path can only be used if no other file has
1481
# already taken this pathname, i.e. if the name is unused, or
1482
# if it is already associated with this trans_id.
1483
elif self._case_sensitive_target:
1484
if (self._limbo_children_names[parent].get(filename)
1485
in (trans_id, None)):
1486
use_direct_path = True
1488
for l_filename, l_trans_id in\
1489
self._limbo_children_names[parent].iteritems():
1490
if l_trans_id == trans_id:
1492
if l_filename.lower() == filename.lower():
1495
use_direct_path = True
1497
if not use_direct_path:
1498
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1500
limbo_name = pathjoin(self._limbo_files[parent], filename)
1501
self._limbo_children[parent].add(trans_id)
1502
self._limbo_children_names[parent][filename] = trans_id
1506
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1507
"""Apply all changes to the inventory and filesystem.
1509
If filesystem or inventory conflicts are present, MalformedTransform
1512
If apply succeeds, finalize is not necessary.
1514
:param no_conflicts: if True, the caller guarantees there are no
1515
conflicts, so no check is made.
1516
:param precomputed_delta: An inventory delta to use instead of
1518
:param _mover: Supply an alternate FileMover, for testing
1520
if not no_conflicts:
1521
self._check_malformed()
1522
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1524
if precomputed_delta is None:
1525
child_pb.update('Apply phase', 0, 2)
1526
inventory_delta = self._generate_inventory_delta()
1529
inventory_delta = precomputed_delta
1532
mover = _FileMover()
1536
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1537
self._apply_removals(mover)
1538
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1539
modified_paths = self._apply_insertions(mover)
1544
mover.apply_deletions()
1547
self._tree.apply_inventory_delta(inventory_delta)
1550
return _TransformResults(modified_paths, self.rename_count)
1552
def _generate_inventory_delta(self):
1553
"""Generate an inventory delta for the current transform."""
1554
inventory_delta = []
1555
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1556
new_paths = self._inventory_altered()
1557
total_entries = len(new_paths) + len(self._removed_id)
1559
for num, trans_id in enumerate(self._removed_id):
1561
child_pb.update('removing file', num, total_entries)
1562
if trans_id == self._new_root:
1563
file_id = self._tree.get_root_id()
1565
file_id = self.tree_file_id(trans_id)
1566
# File-id isn't really being deleted, just moved
1567
if file_id in self._r_new_id:
1569
path = self._tree_id_paths[trans_id]
1570
inventory_delta.append((path, None, file_id, None))
1571
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1573
entries = self._tree.iter_entries_by_dir(
1574
new_path_file_ids.values())
1575
old_paths = dict((e.file_id, p) for p, e in entries)
1577
for num, (path, trans_id) in enumerate(new_paths):
1579
child_pb.update('adding file',
1580
num + len(self._removed_id), total_entries)
1581
file_id = new_path_file_ids[trans_id]
1586
kind = self.final_kind(trans_id)
1588
kind = self._tree.stored_kind(file_id)
1589
parent_trans_id = self.final_parent(trans_id)
1590
parent_file_id = new_path_file_ids.get(parent_trans_id)
1591
if parent_file_id is None:
1592
parent_file_id = self.final_file_id(parent_trans_id)
1593
if trans_id in self._new_reference_revision:
1594
new_entry = inventory.TreeReference(
1596
self._new_name[trans_id],
1597
self.final_file_id(self._new_parent[trans_id]),
1598
None, self._new_reference_revision[trans_id])
1600
new_entry = inventory.make_entry(kind,
1601
self.final_name(trans_id),
1602
parent_file_id, file_id)
1603
old_path = old_paths.get(new_entry.file_id)
1604
new_executability = self._new_executability.get(trans_id)
1605
if new_executability is not None:
1606
new_entry.executable = new_executability
1607
inventory_delta.append(
1608
(old_path, path, new_entry.file_id, new_entry))
1611
return inventory_delta
1613
def _apply_removals(self, mover):
1614
"""Perform tree operations that remove directory/inventory names.
1616
That is, delete files that are to be deleted, and put any files that
1617
need renaming into limbo. This must be done in strict child-to-parent
1620
If inventory_delta is None, no inventory delta generation is performed.
1622
tree_paths = list(self._tree_path_ids.iteritems())
1623
tree_paths.sort(reverse=True)
1624
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1626
for num, data in enumerate(tree_paths):
1627
path, trans_id = data
1628
child_pb.update('removing file', num, len(tree_paths))
1629
full_path = self._tree.abspath(path)
1630
if trans_id in self._removed_contents:
1631
delete_path = os.path.join(self._deletiondir, trans_id)
1632
mover.pre_delete(full_path, delete_path)
1633
elif (trans_id in self._new_name
1634
or trans_id in self._new_parent):
1636
mover.rename(full_path, self._limbo_name(trans_id))
1638
if e.errno != errno.ENOENT:
1641
self.rename_count += 1
1645
def _apply_insertions(self, mover):
1646
"""Perform tree operations that insert directory/inventory names.
1648
That is, create any files that need to be created, and restore from
1649
limbo any files that needed renaming. This must be done in strict
1650
parent-to-child order.
1652
If inventory_delta is None, no inventory delta is calculated, and
1653
no list of modified paths is returned.
1655
new_paths = self.new_paths(filesystem_only=True)
1657
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1659
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1661
for num, (path, trans_id) in enumerate(new_paths):
1663
child_pb.update('adding file', num, len(new_paths))
1664
full_path = self._tree.abspath(path)
1665
if trans_id in self._needs_rename:
1667
mover.rename(self._limbo_name(trans_id), full_path)
1669
# We may be renaming a dangling inventory id
1670
if e.errno != errno.ENOENT:
1673
self.rename_count += 1
1674
if (trans_id in self._new_contents or
1675
self.path_changed(trans_id)):
1676
if trans_id in self._new_contents:
1677
modified_paths.append(full_path)
1678
if trans_id in self._new_executability:
1679
self._set_executability(path, trans_id)
1682
self._new_contents.clear()
1683
return modified_paths
1686
class TransformPreview(DiskTreeTransform):
1687
"""A TreeTransform for generating preview trees.
1689
Unlike TreeTransform, this version works when the input tree is a
1690
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1691
unversioned files in the input tree.
1694
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1696
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1697
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1699
def canonical_path(self, path):
1702
def tree_kind(self, trans_id):
1703
path = self._tree_id_paths.get(trans_id)
1705
raise NoSuchFile(None)
1706
file_id = self._tree.path2id(path)
1707
return self._tree.kind(file_id)
1709
def _set_mode(self, trans_id, mode_id, typefunc):
1710
"""Set the mode of new file contents.
1711
The mode_id is the existing file to get the mode from (often the same
1712
as trans_id). The operation is only performed if there's a mode match
1713
according to typefunc.
1715
# is it ok to ignore this? probably
1718
def iter_tree_children(self, parent_id):
1719
"""Iterate through the entry's tree children, if any"""
1721
path = self._tree_id_paths[parent_id]
1724
file_id = self.tree_file_id(parent_id)
1727
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1728
children = getattr(entry, 'children', {})
1729
for child in children:
1730
childpath = joinpath(path, child)
1731
yield self.trans_id_tree_path(childpath)
1734
class _PreviewTree(tree.Tree):
1735
"""Partial implementation of Tree to support show_diff_trees"""
1737
def __init__(self, transform):
1738
self._transform = transform
1739
self._final_paths = FinalPaths(transform)
1740
self.__by_parent = None
1741
self._parent_ids = []
1742
self._all_children_cache = {}
1743
self._path2trans_id_cache = {}
1744
self._final_name_cache = {}
1745
self._iter_changes_cache = dict((c[0], c) for c in
1746
self._transform.iter_changes())
1748
def _content_change(self, file_id):
1749
"""Return True if the content of this file changed"""
1750
changes = self._iter_changes_cache.get(file_id)
1751
# changes[2] is true if the file content changed. See
1752
# InterTree.iter_changes.
1753
return (changes is not None and changes[2])
1755
def _get_repository(self):
1756
repo = getattr(self._transform._tree, '_repository', None)
1758
repo = self._transform._tree.branch.repository
1761
def _iter_parent_trees(self):
1762
for revision_id in self.get_parent_ids():
1764
yield self.revision_tree(revision_id)
1765
except errors.NoSuchRevisionInTree:
1766
yield self._get_repository().revision_tree(revision_id)
1768
def _get_file_revision(self, file_id, vf, tree_revision):
1769
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1770
self._iter_parent_trees()]
1771
vf.add_lines((file_id, tree_revision), parent_keys,
1772
self.get_file(file_id).readlines())
1773
repo = self._get_repository()
1774
base_vf = repo.texts
1775
if base_vf not in vf.fallback_versionedfiles:
1776
vf.fallback_versionedfiles.append(base_vf)
1777
return tree_revision
1779
def _stat_limbo_file(self, file_id):
1780
trans_id = self._transform.trans_id_file_id(file_id)
1781
name = self._transform._limbo_name(trans_id)
1782
return os.lstat(name)
1785
def _by_parent(self):
1786
if self.__by_parent is None:
1787
self.__by_parent = self._transform.by_parent()
1788
return self.__by_parent
1790
def _comparison_data(self, entry, path):
1791
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1792
if kind == 'missing':
1796
file_id = self._transform.final_file_id(self._path2trans_id(path))
1797
executable = self.is_executable(file_id, path)
1798
return kind, executable, None
1800
def lock_read(self):
1801
# Perhaps in theory, this should lock the TreeTransform?
1808
def inventory(self):
1809
"""This Tree does not use inventory as its backing data."""
1810
raise NotImplementedError(_PreviewTree.inventory)
1812
def get_root_id(self):
1813
return self._transform.final_file_id(self._transform.root)
1815
def all_file_ids(self):
1816
tree_ids = set(self._transform._tree.all_file_ids())
1817
tree_ids.difference_update(self._transform.tree_file_id(t)
1818
for t in self._transform._removed_id)
1819
tree_ids.update(self._transform._new_id.values())
1823
return iter(self.all_file_ids())
1825
def _has_id(self, file_id, fallback_check):
1826
if file_id in self._transform._r_new_id:
1828
elif file_id in set([self._transform.tree_file_id(trans_id) for
1829
trans_id in self._transform._removed_id]):
1832
return fallback_check(file_id)
1834
def has_id(self, file_id):
1835
return self._has_id(file_id, self._transform._tree.has_id)
1837
def has_or_had_id(self, file_id):
1838
return self._has_id(file_id, self._transform._tree.has_or_had_id)
1840
def _path2trans_id(self, path):
1841
# We must not use None here, because that is a valid value to store.
1842
trans_id = self._path2trans_id_cache.get(path, object)
1843
if trans_id is not object:
1845
segments = splitpath(path)
1846
cur_parent = self._transform.root
1847
for cur_segment in segments:
1848
for child in self._all_children(cur_parent):
1849
final_name = self._final_name_cache.get(child)
1850
if final_name is None:
1851
final_name = self._transform.final_name(child)
1852
self._final_name_cache[child] = final_name
1853
if final_name == cur_segment:
1857
self._path2trans_id_cache[path] = None
1859
self._path2trans_id_cache[path] = cur_parent
1862
def path2id(self, path):
1863
return self._transform.final_file_id(self._path2trans_id(path))
1865
def id2path(self, file_id):
1866
trans_id = self._transform.trans_id_file_id(file_id)
1868
return self._final_paths._determine_path(trans_id)
1870
raise errors.NoSuchId(self, file_id)
1872
def _all_children(self, trans_id):
1873
children = self._all_children_cache.get(trans_id)
1874
if children is not None:
1876
children = set(self._transform.iter_tree_children(trans_id))
1877
# children in the _new_parent set are provided by _by_parent.
1878
children.difference_update(self._transform._new_parent.keys())
1879
children.update(self._by_parent.get(trans_id, []))
1880
self._all_children_cache[trans_id] = children
1883
def iter_children(self, file_id):
1884
trans_id = self._transform.trans_id_file_id(file_id)
1885
for child_trans_id in self._all_children(trans_id):
1886
yield self._transform.final_file_id(child_trans_id)
1889
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1890
in self._transform._tree.extras())
1891
possible_extras.update(self._transform._new_contents)
1892
possible_extras.update(self._transform._removed_id)
1893
for trans_id in possible_extras:
1894
if self._transform.final_file_id(trans_id) is None:
1895
yield self._final_paths._determine_path(trans_id)
1897
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1898
yield_parents=False):
1899
for trans_id, parent_file_id in ordered_entries:
1900
file_id = self._transform.final_file_id(trans_id)
1903
if (specific_file_ids is not None
1904
and file_id not in specific_file_ids):
1907
kind = self._transform.final_kind(trans_id)
1909
kind = self._transform._tree.stored_kind(file_id)
1910
new_entry = inventory.make_entry(
1912
self._transform.final_name(trans_id),
1913
parent_file_id, file_id)
1914
yield new_entry, trans_id
1916
def _list_files_by_dir(self):
1917
todo = [ROOT_PARENT]
1919
while len(todo) > 0:
1921
parent_file_id = self._transform.final_file_id(parent)
1922
children = list(self._all_children(parent))
1923
paths = dict(zip(children, self._final_paths.get_paths(children)))
1924
children.sort(key=paths.get)
1925
todo.extend(reversed(children))
1926
for trans_id in children:
1927
ordered_ids.append((trans_id, parent_file_id))
1930
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1931
# This may not be a maximally efficient implementation, but it is
1932
# reasonably straightforward. An implementation that grafts the
1933
# TreeTransform changes onto the tree's iter_entries_by_dir results
1934
# might be more efficient, but requires tricky inferences about stack
1936
ordered_ids = self._list_files_by_dir()
1937
for entry, trans_id in self._make_inv_entries(ordered_ids,
1938
specific_file_ids, yield_parents=yield_parents):
1939
yield unicode(self._final_paths.get_path(trans_id)), entry
1941
def _iter_entries_for_dir(self, dir_path):
1942
"""Return path, entry for items in a directory without recursing down."""
1943
dir_file_id = self.path2id(dir_path)
1945
for file_id in self.iter_children(dir_file_id):
1946
trans_id = self._transform.trans_id_file_id(file_id)
1947
ordered_ids.append((trans_id, file_id))
1948
for entry, trans_id in self._make_inv_entries(ordered_ids):
1949
yield unicode(self._final_paths.get_path(trans_id)), entry
1951
def list_files(self, include_root=False, from_dir=None, recursive=True):
1952
"""See WorkingTree.list_files."""
1953
# XXX This should behave like WorkingTree.list_files, but is really
1954
# more like RevisionTree.list_files.
1958
prefix = from_dir + '/'
1959
entries = self.iter_entries_by_dir()
1960
for path, entry in entries:
1961
if entry.name == '' and not include_root:
1964
if not path.startswith(prefix):
1966
path = path[len(prefix):]
1967
yield path, 'V', entry.kind, entry.file_id, entry
1969
if from_dir is None and include_root is True:
1970
root_entry = inventory.make_entry('directory', '',
1971
ROOT_PARENT, self.get_root_id())
1972
yield '', 'V', 'directory', root_entry.file_id, root_entry
1973
entries = self._iter_entries_for_dir(from_dir or '')
1974
for path, entry in entries:
1975
yield path, 'V', entry.kind, entry.file_id, entry
1977
def kind(self, file_id):
1978
trans_id = self._transform.trans_id_file_id(file_id)
1979
return self._transform.final_kind(trans_id)
1981
def stored_kind(self, file_id):
1982
trans_id = self._transform.trans_id_file_id(file_id)
1984
return self._transform._new_contents[trans_id]
1986
return self._transform._tree.stored_kind(file_id)
1988
def get_file_mtime(self, file_id, path=None):
1989
"""See Tree.get_file_mtime"""
1990
if not self._content_change(file_id):
1991
return self._transform._tree.get_file_mtime(file_id)
1992
return self._stat_limbo_file(file_id).st_mtime
1994
def _file_size(self, entry, stat_value):
1995
return self.get_file_size(entry.file_id)
1997
def get_file_size(self, file_id):
1998
"""See Tree.get_file_size"""
1999
if self.kind(file_id) == 'file':
2000
return self._transform._tree.get_file_size(file_id)
2004
def get_file_sha1(self, file_id, path=None, stat_value=None):
2005
trans_id = self._transform.trans_id_file_id(file_id)
2006
kind = self._transform._new_contents.get(trans_id)
2008
return self._transform._tree.get_file_sha1(file_id)
2010
fileobj = self.get_file(file_id)
2012
return sha_file(fileobj)
2016
def is_executable(self, file_id, path=None):
2019
trans_id = self._transform.trans_id_file_id(file_id)
2021
return self._transform._new_executability[trans_id]
2024
return self._transform._tree.is_executable(file_id, path)
2026
if e.errno == errno.ENOENT:
2029
except errors.NoSuchId:
2032
def path_content_summary(self, path):
2033
trans_id = self._path2trans_id(path)
2034
tt = self._transform
2035
tree_path = tt._tree_id_paths.get(trans_id)
2036
kind = tt._new_contents.get(trans_id)
2038
if tree_path is None or trans_id in tt._removed_contents:
2039
return 'missing', None, None, None
2040
summary = tt._tree.path_content_summary(tree_path)
2041
kind, size, executable, link_or_sha1 = summary
2044
limbo_name = tt._limbo_name(trans_id)
2045
if trans_id in tt._new_reference_revision:
2046
kind = 'tree-reference'
2048
statval = os.lstat(limbo_name)
2049
size = statval.st_size
2050
if not supports_executable():
2053
executable = statval.st_mode & S_IEXEC
2057
if kind == 'symlink':
2058
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2059
executable = tt._new_executability.get(trans_id, executable)
2060
return kind, size, executable, link_or_sha1
2062
def iter_changes(self, from_tree, include_unchanged=False,
2063
specific_files=None, pb=None, extra_trees=None,
2064
require_versioned=True, want_unversioned=False):
2065
"""See InterTree.iter_changes.
2067
This has a fast path that is only used when the from_tree matches
2068
the transform tree, and no fancy options are supplied.
2070
if (from_tree is not self._transform._tree or include_unchanged or
2071
specific_files or want_unversioned):
2072
return tree.InterTree(from_tree, self).iter_changes(
2073
include_unchanged=include_unchanged,
2074
specific_files=specific_files,
2076
extra_trees=extra_trees,
2077
require_versioned=require_versioned,
2078
want_unversioned=want_unversioned)
2079
if want_unversioned:
2080
raise ValueError('want_unversioned is not supported')
2081
return self._transform.iter_changes()
2083
def get_file(self, file_id, path=None):
2084
"""See Tree.get_file"""
2085
if not self._content_change(file_id):
2086
return self._transform._tree.get_file(file_id, path)
2087
trans_id = self._transform.trans_id_file_id(file_id)
2088
name = self._transform._limbo_name(trans_id)
2089
return open(name, 'rb')
2091
def get_file_with_stat(self, file_id, path=None):
2092
return self.get_file(file_id, path), None
2094
def annotate_iter(self, file_id,
2095
default_revision=_mod_revision.CURRENT_REVISION):
2096
changes = self._iter_changes_cache.get(file_id)
2100
changed_content, versioned, kind = (changes[2], changes[3],
2104
get_old = (kind[0] == 'file' and versioned[0])
2106
old_annotation = self._transform._tree.annotate_iter(file_id,
2107
default_revision=default_revision)
2111
return old_annotation
2112
if not changed_content:
2113
return old_annotation
2114
# TODO: This is doing something similar to what WT.annotate_iter is
2115
# doing, however it fails slightly because it doesn't know what
2116
# the *other* revision_id is, so it doesn't know how to give the
2117
# other as the origin for some lines, they all get
2118
# 'default_revision'
2119
# It would be nice to be able to use the new Annotator based
2120
# approach, as well.
2121
return annotate.reannotate([old_annotation],
2122
self.get_file(file_id).readlines(),
2125
def get_symlink_target(self, file_id):
2126
"""See Tree.get_symlink_target"""
2127
if not self._content_change(file_id):
2128
return self._transform._tree.get_symlink_target(file_id)
2129
trans_id = self._transform.trans_id_file_id(file_id)
2130
name = self._transform._limbo_name(trans_id)
2131
return osutils.readlink(name)
2133
def walkdirs(self, prefix=''):
2134
pending = [self._transform.root]
2135
while len(pending) > 0:
2136
parent_id = pending.pop()
2139
prefix = prefix.rstrip('/')
2140
parent_path = self._final_paths.get_path(parent_id)
2141
parent_file_id = self._transform.final_file_id(parent_id)
2142
for child_id in self._all_children(parent_id):
2143
path_from_root = self._final_paths.get_path(child_id)
2144
basename = self._transform.final_name(child_id)
2145
file_id = self._transform.final_file_id(child_id)
2147
kind = self._transform.final_kind(child_id)
2148
versioned_kind = kind
2151
versioned_kind = self._transform._tree.stored_kind(file_id)
2152
if versioned_kind == 'directory':
2153
subdirs.append(child_id)
2154
children.append((path_from_root, basename, kind, None,
2155
file_id, versioned_kind))
2157
if parent_path.startswith(prefix):
2158
yield (parent_path, parent_file_id), children
2159
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2162
def get_parent_ids(self):
2163
return self._parent_ids
2165
def set_parent_ids(self, parent_ids):
2166
self._parent_ids = parent_ids
2168
def get_revision_tree(self, revision_id):
2169
return self._transform._tree.get_revision_tree(revision_id)
2172
def joinpath(parent, child):
2173
"""Join tree-relative paths, handling the tree root specially"""
2174
if parent is None or parent == "":
2177
return pathjoin(parent, child)
2180
class FinalPaths(object):
2181
"""Make path calculation cheap by memoizing paths.
2183
The underlying tree must not be manipulated between calls, or else
2184
the results will likely be incorrect.
2186
def __init__(self, transform):
2187
object.__init__(self)
2188
self._known_paths = {}
2189
self.transform = transform
2191
def _determine_path(self, trans_id):
2192
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2194
name = self.transform.final_name(trans_id)
2195
parent_id = self.transform.final_parent(trans_id)
2196
if parent_id == self.transform.root:
2199
return pathjoin(self.get_path(parent_id), name)
2201
def get_path(self, trans_id):
2202
"""Find the final path associated with a trans_id"""
2203
if trans_id not in self._known_paths:
2204
self._known_paths[trans_id] = self._determine_path(trans_id)
2205
return self._known_paths[trans_id]
2207
def get_paths(self, trans_ids):
2208
return [(self.get_path(t), t) for t in trans_ids]
2212
def topology_sorted_ids(tree):
2213
"""Determine the topological order of the ids in a tree"""
2214
file_ids = list(tree)
2215
file_ids.sort(key=tree.id2path)
2219
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2220
delta_from_tree=False):
2221
"""Create working tree for a branch, using a TreeTransform.
2223
This function should be used on empty trees, having a tree root at most.
2224
(see merge and revert functionality for working with existing trees)
2226
Existing files are handled like so:
2228
- Existing bzrdirs take precedence over creating new items. They are
2229
created as '%s.diverted' % name.
2230
- Otherwise, if the content on disk matches the content we are building,
2231
it is silently replaced.
2232
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2234
:param tree: The tree to convert wt into a copy of
2235
:param wt: The working tree that files will be placed into
2236
:param accelerator_tree: A tree which can be used for retrieving file
2237
contents more quickly than tree itself, i.e. a workingtree. tree
2238
will be used for cases where accelerator_tree's content is different.
2239
:param hardlink: If true, hard-link files to accelerator_tree, where
2240
possible. accelerator_tree must implement abspath, i.e. be a
2242
:param delta_from_tree: If true, build_tree may use the input Tree to
2243
generate the inventory delta.
2245
wt.lock_tree_write()
2249
if accelerator_tree is not None:
2250
accelerator_tree.lock_read()
2252
return _build_tree(tree, wt, accelerator_tree, hardlink,
2255
if accelerator_tree is not None:
2256
accelerator_tree.unlock()
2263
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2264
"""See build_tree."""
2265
for num, _unused in enumerate(wt.all_file_ids()):
2266
if num > 0: # more than just a root
2267
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2268
existing_files = set()
2269
for dir, files in wt.walkdirs():
2270
existing_files.update(f[0] for f in files)
2272
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2273
pp = ProgressPhase("Build phase", 2, top_pb)
2274
if tree.inventory.root is not None:
2275
# This is kind of a hack: we should be altering the root
2276
# as part of the regular tree shape diff logic.
2277
# The conditional test here is to avoid doing an
2278
# expensive operation (flush) every time the root id
2279
# is set within the tree, nor setting the root and thus
2280
# marking the tree as dirty, because we use two different
2281
# idioms here: tree interfaces and inventory interfaces.
2282
if wt.get_root_id() != tree.get_root_id():
2283
wt.set_root_id(tree.get_root_id())
2285
tt = TreeTransform(wt)
2289
file_trans_id[wt.get_root_id()] = \
2290
tt.trans_id_tree_file_id(wt.get_root_id())
2291
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2293
deferred_contents = []
2295
total = len(tree.inventory)
2297
precomputed_delta = []
2299
precomputed_delta = None
2300
for num, (tree_path, entry) in \
2301
enumerate(tree.inventory.iter_entries_by_dir()):
2302
pb.update("Building tree", num - len(deferred_contents), total)
2303
if entry.parent_id is None:
2306
file_id = entry.file_id
2308
precomputed_delta.append((None, tree_path, file_id, entry))
2309
if tree_path in existing_files:
2310
target_path = wt.abspath(tree_path)
2311
kind = file_kind(target_path)
2312
if kind == "directory":
2314
bzrdir.BzrDir.open(target_path)
2315
except errors.NotBranchError:
2319
if (file_id not in divert and
2320
_content_match(tree, entry, file_id, kind,
2322
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2323
if kind == 'directory':
2325
parent_id = file_trans_id[entry.parent_id]
2326
if entry.kind == 'file':
2327
# We *almost* replicate new_by_entry, so that we can defer
2328
# getting the file text, and get them all at once.
2329
trans_id = tt.create_path(entry.name, parent_id)
2330
file_trans_id[file_id] = trans_id
2331
tt.version_file(file_id, trans_id)
2332
executable = tree.is_executable(file_id, tree_path)
2334
tt.set_executability(executable, trans_id)
2335
trans_data = (trans_id, tree_path)
2336
deferred_contents.append((file_id, trans_data))
2338
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2341
new_trans_id = file_trans_id[file_id]
2342
old_parent = tt.trans_id_tree_path(tree_path)
2343
_reparent_children(tt, old_parent, new_trans_id)
2344
offset = num + 1 - len(deferred_contents)
2345
_create_files(tt, tree, deferred_contents, pb, offset,
2346
accelerator_tree, hardlink)
2350
divert_trans = set(file_trans_id[f] for f in divert)
2351
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2352
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2353
if len(raw_conflicts) > 0:
2354
precomputed_delta = None
2355
conflicts = cook_conflicts(raw_conflicts, tt)
2356
for conflict in conflicts:
2359
wt.add_conflicts(conflicts)
2360
except errors.UnsupportedOperation:
2362
result = tt.apply(no_conflicts=True,
2363
precomputed_delta=precomputed_delta)
2370
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2372
total = len(desired_files) + offset
2374
if accelerator_tree is None:
2375
new_desired_files = desired_files
2377
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2378
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2379
in iter if not (c or e[0] != e[1])]
2380
if accelerator_tree.supports_content_filtering():
2381
unchanged = [(f, p) for (f, p) in unchanged
2382
if not accelerator_tree.iter_search_rules([p]).next()]
2383
unchanged = dict(unchanged)
2384
new_desired_files = []
2386
for file_id, (trans_id, tree_path) in desired_files:
2387
accelerator_path = unchanged.get(file_id)
2388
if accelerator_path is None:
2389
new_desired_files.append((file_id, (trans_id, tree_path)))
2391
pb.update('Adding file contents', count + offset, total)
2393
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2396
contents = accelerator_tree.get_file(file_id, accelerator_path)
2397
if wt.supports_content_filtering():
2398
filters = wt._content_filter_stack(tree_path)
2399
contents = filtered_output_bytes(contents, filters,
2400
ContentFilterContext(tree_path, tree))
2402
tt.create_file(contents, trans_id)
2406
except AttributeError:
2407
# after filtering, contents may no longer be file-like
2411
for count, ((trans_id, tree_path), contents) in enumerate(
2412
tree.iter_files_bytes(new_desired_files)):
2413
if wt.supports_content_filtering():
2414
filters = wt._content_filter_stack(tree_path)
2415
contents = filtered_output_bytes(contents, filters,
2416
ContentFilterContext(tree_path, tree))
2417
tt.create_file(contents, trans_id)
2418
pb.update('Adding file contents', count + offset, total)
2421
def _reparent_children(tt, old_parent, new_parent):
2422
for child in tt.iter_tree_children(old_parent):
2423
tt.adjust_path(tt.final_name(child), new_parent, child)
2425
def _reparent_transform_children(tt, old_parent, new_parent):
2426
by_parent = tt.by_parent()
2427
for child in by_parent[old_parent]:
2428
tt.adjust_path(tt.final_name(child), new_parent, child)
2429
return by_parent[old_parent]
2431
def _content_match(tree, entry, file_id, kind, target_path):
2432
if entry.kind != kind:
2434
if entry.kind == "directory":
2436
if entry.kind == "file":
2437
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2439
elif entry.kind == "symlink":
2440
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2445
def resolve_checkout(tt, conflicts, divert):
2446
new_conflicts = set()
2447
for c_type, conflict in ((c[0], c) for c in conflicts):
2448
# Anything but a 'duplicate' would indicate programmer error
2449
if c_type != 'duplicate':
2450
raise AssertionError(c_type)
2451
# Now figure out which is new and which is old
2452
if tt.new_contents(conflict[1]):
2453
new_file = conflict[1]
2454
old_file = conflict[2]
2456
new_file = conflict[2]
2457
old_file = conflict[1]
2459
# We should only get here if the conflict wasn't completely
2461
final_parent = tt.final_parent(old_file)
2462
if new_file in divert:
2463
new_name = tt.final_name(old_file)+'.diverted'
2464
tt.adjust_path(new_name, final_parent, new_file)
2465
new_conflicts.add((c_type, 'Diverted to',
2466
new_file, old_file))
2468
new_name = tt.final_name(old_file)+'.moved'
2469
tt.adjust_path(new_name, final_parent, old_file)
2470
new_conflicts.add((c_type, 'Moved existing file to',
2471
old_file, new_file))
2472
return new_conflicts
2475
def new_by_entry(tt, entry, parent_id, tree):
2476
"""Create a new file according to its inventory entry"""
2480
contents = tree.get_file(entry.file_id).readlines()
2481
executable = tree.is_executable(entry.file_id)
2482
return tt.new_file(name, parent_id, contents, entry.file_id,
2484
elif kind in ('directory', 'tree-reference'):
2485
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2486
if kind == 'tree-reference':
2487
tt.set_tree_reference(entry.reference_revision, trans_id)
2489
elif kind == 'symlink':
2490
target = tree.get_symlink_target(entry.file_id)
2491
return tt.new_symlink(name, parent_id, target, entry.file_id)
2493
raise errors.BadFileKindError(name, kind)
2496
@deprecated_function(deprecated_in((1, 9, 0)))
2497
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2498
"""Create new file contents according to an inventory entry.
2500
DEPRECATED. Use create_from_tree instead.
2502
if entry.kind == "file":
2504
lines = tree.get_file(entry.file_id).readlines()
2505
tt.create_file(lines, trans_id, mode_id=mode_id)
2506
elif entry.kind == "symlink":
2507
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2508
elif entry.kind == "directory":
2509
tt.create_directory(trans_id)
2512
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2513
filter_tree_path=None):
2514
"""Create new file contents according to tree contents.
2516
:param filter_tree_path: the tree path to use to lookup
2517
content filters to apply to the bytes output in the working tree.
2518
This only applies if the working tree supports content filtering.
2520
kind = tree.kind(file_id)
2521
if kind == 'directory':
2522
tt.create_directory(trans_id)
2523
elif kind == "file":
2525
tree_file = tree.get_file(file_id)
2527
bytes = tree_file.readlines()
2531
if wt.supports_content_filtering() and filter_tree_path is not None:
2532
filters = wt._content_filter_stack(filter_tree_path)
2533
bytes = filtered_output_bytes(bytes, filters,
2534
ContentFilterContext(filter_tree_path, tree))
2535
tt.create_file(bytes, trans_id)
2536
elif kind == "symlink":
2537
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2539
raise AssertionError('Unknown kind %r' % kind)
2542
def create_entry_executability(tt, entry, trans_id):
2543
"""Set the executability of a trans_id according to an inventory entry"""
2544
if entry.kind == "file":
2545
tt.set_executability(entry.executable, trans_id)
2548
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2549
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2552
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2553
"""Produce a backup-style name that appears to be available"""
2557
yield "%s.~%d~" % (name, counter)
2559
for new_name in name_gen():
2560
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2564
def _entry_changes(file_id, entry, working_tree):
2565
"""Determine in which ways the inventory entry has changed.
2567
Returns booleans: has_contents, content_mod, meta_mod
2568
has_contents means there are currently contents, but they differ
2569
contents_mod means contents need to be modified
2570
meta_mod means the metadata needs to be modified
2572
cur_entry = working_tree.inventory[file_id]
2574
working_kind = working_tree.kind(file_id)
2577
has_contents = False
2580
if has_contents is True:
2581
if entry.kind != working_kind:
2582
contents_mod, meta_mod = True, False
2584
cur_entry._read_tree_state(working_tree.id2path(file_id),
2586
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2587
cur_entry._forget_tree_state()
2588
return has_contents, contents_mod, meta_mod
2591
def revert(working_tree, target_tree, filenames, backups=False,
2592
pb=DummyProgress(), change_reporter=None):
2593
"""Revert a working tree's contents to those of a target tree."""
2594
target_tree.lock_read()
2595
tt = TreeTransform(working_tree, pb)
2597
pp = ProgressPhase("Revert phase", 3, pb)
2598
conflicts, merge_modified = _prepare_revert_transform(
2599
working_tree, target_tree, tt, filenames, backups, pp)
2601
change_reporter = delta._ChangeReporter(
2602
unversioned_filter=working_tree.is_ignored)
2603
delta.report_changes(tt.iter_changes(), change_reporter)
2604
for conflict in conflicts:
2608
working_tree.set_merge_modified(merge_modified)
2610
target_tree.unlock()
2616
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2617
backups, pp, basis_tree=None,
2618
merge_modified=None):
2620
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2622
if merge_modified is None:
2623
merge_modified = working_tree.merge_modified()
2624
merge_modified = _alter_files(working_tree, target_tree, tt,
2625
child_pb, filenames, backups,
2626
merge_modified, basis_tree)
2630
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2632
raw_conflicts = resolve_conflicts(tt, child_pb,
2633
lambda t, c: conflict_pass(t, c, target_tree))
2636
conflicts = cook_conflicts(raw_conflicts, tt)
2637
return conflicts, merge_modified
2640
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2641
backups, merge_modified, basis_tree=None):
2642
if basis_tree is not None:
2643
basis_tree.lock_read()
2644
change_list = target_tree.iter_changes(working_tree,
2645
specific_files=specific_files, pb=pb)
2646
if target_tree.get_root_id() is None:
2652
for id_num, (file_id, path, changed_content, versioned, parent, name,
2653
kind, executable) in enumerate(change_list):
2654
if skip_root and file_id[0] is not None and parent[0] is None:
2656
trans_id = tt.trans_id_file_id(file_id)
2659
keep_content = False
2660
if kind[0] == 'file' and (backups or kind[1] is None):
2661
wt_sha1 = working_tree.get_file_sha1(file_id)
2662
if merge_modified.get(file_id) != wt_sha1:
2663
# acquire the basis tree lazily to prevent the
2664
# expense of accessing it when it's not needed ?
2665
# (Guessing, RBC, 200702)
2666
if basis_tree is None:
2667
basis_tree = working_tree.basis_tree()
2668
basis_tree.lock_read()
2669
if file_id in basis_tree:
2670
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2672
elif kind[1] is None and not versioned[1]:
2674
if kind[0] is not None:
2675
if not keep_content:
2676
tt.delete_contents(trans_id)
2677
elif kind[1] is not None:
2678
parent_trans_id = tt.trans_id_file_id(parent[0])
2679
by_parent = tt.by_parent()
2680
backup_name = _get_backup_name(name[0], by_parent,
2681
parent_trans_id, tt)
2682
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2683
new_trans_id = tt.create_path(name[0], parent_trans_id)
2684
if versioned == (True, True):
2685
tt.unversion_file(trans_id)
2686
tt.version_file(file_id, new_trans_id)
2687
# New contents should have the same unix perms as old
2690
trans_id = new_trans_id
2691
if kind[1] in ('directory', 'tree-reference'):
2692
tt.create_directory(trans_id)
2693
if kind[1] == 'tree-reference':
2694
revision = target_tree.get_reference_revision(file_id,
2696
tt.set_tree_reference(revision, trans_id)
2697
elif kind[1] == 'symlink':
2698
tt.create_symlink(target_tree.get_symlink_target(file_id),
2700
elif kind[1] == 'file':
2701
deferred_files.append((file_id, (trans_id, mode_id)))
2702
if basis_tree is None:
2703
basis_tree = working_tree.basis_tree()
2704
basis_tree.lock_read()
2705
new_sha1 = target_tree.get_file_sha1(file_id)
2706
if (file_id in basis_tree and new_sha1 ==
2707
basis_tree.get_file_sha1(file_id)):
2708
if file_id in merge_modified:
2709
del merge_modified[file_id]
2711
merge_modified[file_id] = new_sha1
2713
# preserve the execute bit when backing up
2714
if keep_content and executable[0] == executable[1]:
2715
tt.set_executability(executable[1], trans_id)
2716
elif kind[1] is not None:
2717
raise AssertionError(kind[1])
2718
if versioned == (False, True):
2719
tt.version_file(file_id, trans_id)
2720
if versioned == (True, False):
2721
tt.unversion_file(trans_id)
2722
if (name[1] is not None and
2723
(name[0] != name[1] or parent[0] != parent[1])):
2724
if name[1] == '' and parent[1] is None:
2725
parent_trans = ROOT_PARENT
2727
parent_trans = tt.trans_id_file_id(parent[1])
2728
if parent[0] is None and versioned[0]:
2729
tt.adjust_root_path(name[1], parent_trans)
2731
tt.adjust_path(name[1], parent_trans, trans_id)
2732
if executable[0] != executable[1] and kind[1] == "file":
2733
tt.set_executability(executable[1], trans_id)
2734
if working_tree.supports_content_filtering():
2735
for index, ((trans_id, mode_id), bytes) in enumerate(
2736
target_tree.iter_files_bytes(deferred_files)):
2737
file_id = deferred_files[index][0]
2738
# We're reverting a tree to the target tree so using the
2739
# target tree to find the file path seems the best choice
2740
# here IMO - Ian C 27/Oct/2009
2741
filter_tree_path = target_tree.id2path(file_id)
2742
filters = working_tree._content_filter_stack(filter_tree_path)
2743
bytes = filtered_output_bytes(bytes, filters,
2744
ContentFilterContext(filter_tree_path, working_tree))
2745
tt.create_file(bytes, trans_id, mode_id)
2747
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2749
tt.create_file(bytes, trans_id, mode_id)
2750
tt.fixup_new_roots()
2752
if basis_tree is not None:
2754
return merge_modified
2757
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2758
"""Make many conflict-resolution attempts, but die if they fail"""
2759
if pass_func is None:
2760
pass_func = conflict_pass
2761
new_conflicts = set()
2764
pb.update('Resolution pass', n+1, 10)
2765
conflicts = tt.find_conflicts()
2766
if len(conflicts) == 0:
2767
return new_conflicts
2768
new_conflicts.update(pass_func(tt, conflicts))
2769
raise MalformedTransform(conflicts=conflicts)
2774
def conflict_pass(tt, conflicts, path_tree=None):
2775
"""Resolve some classes of conflicts.
2777
:param tt: The transform to resolve conflicts in
2778
:param conflicts: The conflicts to resolve
2779
:param path_tree: A Tree to get supplemental paths from
2781
new_conflicts = set()
2782
for c_type, conflict in ((c[0], c) for c in conflicts):
2783
if c_type == 'duplicate id':
2784
tt.unversion_file(conflict[1])
2785
new_conflicts.add((c_type, 'Unversioned existing file',
2786
conflict[1], conflict[2], ))
2787
elif c_type == 'duplicate':
2788
# files that were renamed take precedence
2789
final_parent = tt.final_parent(conflict[1])
2790
if tt.path_changed(conflict[1]):
2791
existing_file, new_file = conflict[2], conflict[1]
2793
existing_file, new_file = conflict[1], conflict[2]
2794
new_name = tt.final_name(existing_file)+'.moved'
2795
tt.adjust_path(new_name, final_parent, existing_file)
2796
new_conflicts.add((c_type, 'Moved existing file to',
2797
existing_file, new_file))
2798
elif c_type == 'parent loop':
2799
# break the loop by undoing one of the ops that caused the loop
2801
while not tt.path_changed(cur):
2802
cur = tt.final_parent(cur)
2803
new_conflicts.add((c_type, 'Cancelled move', cur,
2804
tt.final_parent(cur),))
2805
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2807
elif c_type == 'missing parent':
2808
trans_id = conflict[1]
2810
tt.cancel_deletion(trans_id)
2811
new_conflicts.add(('deleting parent', 'Not deleting',
2816
tt.final_name(trans_id)
2818
if path_tree is not None:
2819
file_id = tt.final_file_id(trans_id)
2821
file_id = tt.inactive_file_id(trans_id)
2822
entry = path_tree.inventory[file_id]
2823
# special-case the other tree root (move its
2824
# children to current root)
2825
if entry.parent_id is None:
2827
moved = _reparent_transform_children(
2828
tt, trans_id, tt.root)
2830
new_conflicts.add((c_type, 'Moved to root',
2833
parent_trans_id = tt.trans_id_file_id(
2835
tt.adjust_path(entry.name, parent_trans_id,
2838
tt.create_directory(trans_id)
2839
new_conflicts.add((c_type, 'Created directory', trans_id))
2840
elif c_type == 'unversioned parent':
2841
file_id = tt.inactive_file_id(conflict[1])
2842
# special-case the other tree root (move its children instead)
2843
if path_tree and file_id in path_tree:
2844
if path_tree.inventory[file_id].parent_id is None:
2846
tt.version_file(file_id, conflict[1])
2847
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2848
elif c_type == 'non-directory parent':
2849
parent_id = conflict[1]
2850
parent_parent = tt.final_parent(parent_id)
2851
parent_name = tt.final_name(parent_id)
2852
parent_file_id = tt.final_file_id(parent_id)
2853
new_parent_id = tt.new_directory(parent_name + '.new',
2854
parent_parent, parent_file_id)
2855
_reparent_transform_children(tt, parent_id, new_parent_id)
2856
if parent_file_id is not None:
2857
tt.unversion_file(parent_id)
2858
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2859
elif c_type == 'versioning no contents':
2860
tt.cancel_versioning(conflict[1])
2861
return new_conflicts
2864
def cook_conflicts(raw_conflicts, tt):
2865
"""Generate a list of cooked conflicts, sorted by file path"""
2866
from bzrlib.conflicts import Conflict
2867
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2868
return sorted(conflict_iter, key=Conflict.sort_key)
2871
def iter_cook_conflicts(raw_conflicts, tt):
2872
from bzrlib.conflicts import Conflict
2874
for conflict in raw_conflicts:
2875
c_type = conflict[0]
2876
action = conflict[1]
2877
modified_path = fp.get_path(conflict[2])
2878
modified_id = tt.final_file_id(conflict[2])
2879
if len(conflict) == 3:
2880
yield Conflict.factory(c_type, action=action, path=modified_path,
2881
file_id=modified_id)
2884
conflicting_path = fp.get_path(conflict[3])
2885
conflicting_id = tt.final_file_id(conflict[3])
2886
yield Conflict.factory(c_type, action=action, path=modified_path,
2887
file_id=modified_id,
2888
conflict_path=conflicting_path,
2889
conflict_file_id=conflicting_id)
2892
class _FileMover(object):
2893
"""Moves and deletes files for TreeTransform, tracking operations"""
2896
self.past_renames = []
2897
self.pending_deletions = []
2899
def rename(self, from_, to):
2900
"""Rename a file from one path to another. Functions like os.rename"""
2902
os.rename(from_, to)
2904
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2905
raise errors.FileExists(to, str(e))
2907
self.past_renames.append((from_, to))
2909
def pre_delete(self, from_, to):
2910
"""Rename a file out of the way and mark it for deletion.
2912
Unlike os.unlink, this works equally well for files and directories.
2913
:param from_: The current file path
2914
:param to: A temporary path for the file
2916
self.rename(from_, to)
2917
self.pending_deletions.append(to)
2920
"""Reverse all renames that have been performed"""
2921
for from_, to in reversed(self.past_renames):
2922
os.rename(to, from_)
2923
# after rollback, don't reuse _FileMover
2925
pending_deletions = None
2927
def apply_deletions(self):
2928
"""Apply all marked deletions"""
2929
for path in self.pending_deletions:
2931
# after apply_deletions, don't reuse _FileMover
2933
pending_deletions = None
added
removed
bzrlib/transform.py
