1
# Copyright (C) 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from stat import S_ISREG
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
31
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
32
ReusingTransform, NotVersionedError, CantMoveRoot,
33
ExistingLimbo, ImmortalLimbo, NoFinalPath,
35
from bzrlib.inventory import InventoryEntry
36
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
37
delete_any, has_symlinks)
38
from bzrlib.progress import DummyProgress, ProgressPhase
39
from bzrlib.symbol_versioning import (
44
from bzrlib.trace import mutter, warning
45
from bzrlib import tree
47
import bzrlib.urlutils as urlutils
50
ROOT_PARENT = "root-parent"
53
def unique_add(map, key, value):
55
raise DuplicateKey(key=key)
59
class _TransformResults(object):
60
def __init__(self, modified_paths, rename_count):
62
self.modified_paths = modified_paths
63
self.rename_count = rename_count
66
class TreeTransformBase(object):
67
"""The base class for TreeTransform and TreeTransformBase"""
69
def __init__(self, tree, limbodir, pb=DummyProgress(),
73
:param tree: The tree that will be transformed, but not necessarily
75
:param limbodir: A directory where new files can be stored until
76
they are installed in their proper places
77
:param pb: A ProgressBar indicating how much progress is being made
78
:param case_sensitive: If True, the target of the transform is
79
case sensitive, not just case preserving.
83
self._limbodir = limbodir
85
# mapping of trans_id -> new basename
87
# mapping of trans_id -> new parent trans_id
89
# mapping of trans_id with new contents -> new file_kind
90
self._new_contents = {}
91
# A mapping of transform ids to their limbo filename
92
self._limbo_files = {}
93
# A mapping of transform ids to a set of the transform ids of children
94
# that their limbo directory has
95
self._limbo_children = {}
96
# Map transform ids to maps of child filename to child transform id
97
self._limbo_children_names = {}
98
# List of transform ids that need to be renamed from limbo into place
99
self._needs_rename = set()
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 file_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
# Cache of realpath results, to speed up canonical_path
120
# Cache of relpath results, to speed up canonical_path
122
# The trans_id that will be used as the tree root
123
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
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
133
def __get_root(self):
134
return self._new_root
136
root = property(__get_root)
139
"""Release the working tree lock, if held, clean up limbo dir.
141
This is required if apply has not been invoked, but can be invoked
144
if self._tree is None:
147
entries = [(self._limbo_name(t), t, k) for t, k in
148
self._new_contents.iteritems()]
149
entries.sort(reverse=True)
150
for path, trans_id, kind in entries:
151
if kind == "directory":
156
os.rmdir(self._limbodir)
158
# We don't especially care *why* the dir is immortal.
159
raise ImmortalLimbo(self._limbodir)
161
os.rmdir(self._deletiondir)
163
raise errors.ImmortalPendingDeletion(self._deletiondir)
168
def _assign_id(self):
169
"""Produce a new tranform id"""
170
new_id = "new-%s" % self._id_number
174
def create_path(self, name, parent):
175
"""Assign a transaction id to a new path"""
176
trans_id = self._assign_id()
177
unique_add(self._new_name, trans_id, name)
178
unique_add(self._new_parent, trans_id, parent)
181
def adjust_path(self, name, parent, trans_id):
182
"""Change the path that is assigned to a transaction id."""
183
if trans_id == self._new_root:
185
previous_parent = self._new_parent.get(trans_id)
186
previous_name = self._new_name.get(trans_id)
187
self._new_name[trans_id] = name
188
self._new_parent[trans_id] = parent
189
if (trans_id in self._limbo_files and
190
trans_id not in self._needs_rename):
191
self._rename_in_limbo([trans_id])
192
self._limbo_children[previous_parent].remove(trans_id)
193
del self._limbo_children_names[previous_parent][previous_name]
195
def _rename_in_limbo(self, trans_ids):
196
"""Fix limbo names so that the right final path is produced.
198
This means we outsmarted ourselves-- we tried to avoid renaming
199
these files later by creating them with their final names in their
200
final parents. But now the previous name or parent is no longer
201
suitable, so we have to rename them.
203
Even for trans_ids that have no new contents, we must remove their
204
entries from _limbo_files, because they are now stale.
206
for trans_id in trans_ids:
207
old_path = self._limbo_files.pop(trans_id)
208
if trans_id not in self._new_contents:
210
new_path = self._limbo_name(trans_id)
211
os.rename(old_path, new_path)
213
def adjust_root_path(self, name, parent):
214
"""Emulate moving the root by moving all children, instead.
216
We do this by undoing the association of root's transaction id with the
217
current tree. This allows us to create a new directory with that
218
transaction id. We unversion the root directory and version the
219
physically new directory, and hope someone versions the tree root
222
old_root = self._new_root
223
old_root_file_id = self.final_file_id(old_root)
224
# force moving all children of root
225
for child_id in self.iter_tree_children(old_root):
226
if child_id != parent:
227
self.adjust_path(self.final_name(child_id),
228
self.final_parent(child_id), child_id)
229
file_id = self.final_file_id(child_id)
230
if file_id is not None:
231
self.unversion_file(child_id)
232
self.version_file(file_id, child_id)
234
# the physical root needs a new transaction id
235
self._tree_path_ids.pop("")
236
self._tree_id_paths.pop(old_root)
237
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
238
if parent == old_root:
239
parent = self._new_root
240
self.adjust_path(name, parent, old_root)
241
self.create_directory(old_root)
242
self.version_file(old_root_file_id, old_root)
243
self.unversion_file(self._new_root)
245
def trans_id_tree_file_id(self, inventory_id):
246
"""Determine the transaction id of a working tree file.
248
This reflects only files that already exist, not ones that will be
249
added by transactions.
251
path = self._tree.inventory.id2path(inventory_id)
252
return self.trans_id_tree_path(path)
254
def trans_id_file_id(self, file_id):
255
"""Determine or set the transaction id associated with a file ID.
256
A new id is only created for file_ids that were never present. If
257
a transaction has been unversioned, it is deliberately still returned.
258
(this will likely lead to an unversioned parent conflict.)
260
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
261
return self._r_new_id[file_id]
262
elif file_id in self._tree.inventory:
263
return self.trans_id_tree_file_id(file_id)
264
elif file_id in self._non_present_ids:
265
return self._non_present_ids[file_id]
267
trans_id = self._assign_id()
268
self._non_present_ids[file_id] = trans_id
271
def canonical_path(self, path):
272
"""Get the canonical tree-relative path"""
273
# don't follow final symlinks
274
abs = self._tree.abspath(path)
275
if abs in self._relpaths:
276
return self._relpaths[abs]
277
dirname, basename = os.path.split(abs)
278
if dirname not in self._realpaths:
279
self._realpaths[dirname] = os.path.realpath(dirname)
280
dirname = self._realpaths[dirname]
281
abs = pathjoin(dirname, basename)
282
if dirname in self._relpaths:
283
relpath = pathjoin(self._relpaths[dirname], basename)
284
relpath = relpath.rstrip('/\\')
286
relpath = self._tree.relpath(abs)
287
self._relpaths[abs] = relpath
290
def trans_id_tree_path(self, path):
291
"""Determine (and maybe set) the transaction ID for a tree path."""
292
path = self.canonical_path(path)
293
if path not in self._tree_path_ids:
294
self._tree_path_ids[path] = self._assign_id()
295
self._tree_id_paths[self._tree_path_ids[path]] = path
296
return self._tree_path_ids[path]
298
def get_tree_parent(self, trans_id):
299
"""Determine id of the parent in the tree."""
300
path = self._tree_id_paths[trans_id]
303
return self.trans_id_tree_path(os.path.dirname(path))
305
def create_file(self, contents, trans_id, mode_id=None):
306
"""Schedule creation of a new file.
310
Contents is an iterator of strings, all of which will be written
311
to the target destination.
313
New file takes the permissions of any existing file with that id,
314
unless mode_id is specified.
316
name = self._limbo_name(trans_id)
320
unique_add(self._new_contents, trans_id, 'file')
322
# Clean up the file, it never got registered so
323
# TreeTransform.finalize() won't clean it up.
328
f.writelines(contents)
331
self._set_mode(trans_id, mode_id, S_ISREG)
333
def _set_mode(self, trans_id, mode_id, typefunc):
334
"""Set the mode of new file contents.
335
The mode_id is the existing file to get the mode from (often the same
336
as trans_id). The operation is only performed if there's a mode match
337
according to typefunc.
342
old_path = self._tree_id_paths[mode_id]
346
mode = os.stat(self._tree.abspath(old_path)).st_mode
348
if e.errno == errno.ENOENT:
353
os.chmod(self._limbo_name(trans_id), mode)
355
def create_directory(self, trans_id):
356
"""Schedule creation of a new directory.
358
See also new_directory.
360
os.mkdir(self._limbo_name(trans_id))
361
unique_add(self._new_contents, trans_id, 'directory')
363
def create_symlink(self, target, trans_id):
364
"""Schedule creation of a new symbolic link.
366
target is a bytestring.
367
See also new_symlink.
370
os.symlink(target, self._limbo_name(trans_id))
371
unique_add(self._new_contents, trans_id, 'symlink')
374
path = FinalPaths(self).get_path(trans_id)
377
raise UnableCreateSymlink(path=path)
379
def cancel_creation(self, trans_id):
380
"""Cancel the creation of new file contents."""
381
del self._new_contents[trans_id]
382
children = self._limbo_children.get(trans_id)
383
# if this is a limbo directory with children, move them before removing
385
if children is not None:
386
self._rename_in_limbo(children)
387
del self._limbo_children[trans_id]
388
del self._limbo_children_names[trans_id]
389
delete_any(self._limbo_name(trans_id))
391
def delete_contents(self, trans_id):
392
"""Schedule the contents of a path entry for deletion"""
393
self.tree_kind(trans_id)
394
self._removed_contents.add(trans_id)
396
def cancel_deletion(self, trans_id):
397
"""Cancel a scheduled deletion"""
398
self._removed_contents.remove(trans_id)
400
def unversion_file(self, trans_id):
401
"""Schedule a path entry to become unversioned"""
402
self._removed_id.add(trans_id)
404
def delete_versioned(self, trans_id):
405
"""Delete and unversion a versioned file"""
406
self.delete_contents(trans_id)
407
self.unversion_file(trans_id)
409
def set_executability(self, executability, trans_id):
410
"""Schedule setting of the 'execute' bit
411
To unschedule, set to None
413
if executability is None:
414
del self._new_executability[trans_id]
416
unique_add(self._new_executability, trans_id, executability)
418
def set_tree_reference(self, revision_id, trans_id):
419
"""Set the reference associated with a directory"""
420
unique_add(self._new_reference_revision, trans_id, revision_id)
422
def version_file(self, file_id, trans_id):
423
"""Schedule a file to become versioned."""
424
assert file_id is not None
425
unique_add(self._new_id, trans_id, file_id)
426
unique_add(self._r_new_id, file_id, trans_id)
428
def cancel_versioning(self, trans_id):
429
"""Undo a previous versioning of a file"""
430
file_id = self._new_id[trans_id]
431
del self._new_id[trans_id]
432
del self._r_new_id[file_id]
435
"""Determine the paths of all new and changed files"""
437
fp = FinalPaths(self)
438
for id_set in (self._new_name, self._new_parent, self._new_contents,
439
self._new_id, self._new_executability):
440
new_ids.update(id_set)
441
new_paths = [(fp.get_path(t), t) for t in new_ids]
445
def tree_kind(self, trans_id):
446
"""Determine the file kind in the working tree.
448
Raises NoSuchFile if the file does not exist
450
path = self._tree_id_paths.get(trans_id)
452
raise NoSuchFile(None)
454
return file_kind(self._tree.abspath(path))
456
if e.errno != errno.ENOENT:
459
raise NoSuchFile(path)
461
def final_kind(self, trans_id):
462
"""Determine the final file kind, after any changes applied.
464
Raises NoSuchFile if the file does not exist/has no contents.
465
(It is conceivable that a path would be created without the
466
corresponding contents insertion command)
468
if trans_id in self._new_contents:
469
return self._new_contents[trans_id]
470
elif trans_id in self._removed_contents:
471
raise NoSuchFile(None)
473
return self.tree_kind(trans_id)
475
def tree_file_id(self, trans_id):
476
"""Determine the file id associated with the trans_id in the tree"""
478
path = self._tree_id_paths[trans_id]
480
# the file is a new, unversioned file, or invalid trans_id
482
# the file is old; the old id is still valid
483
if self._new_root == trans_id:
484
return self._tree.get_root_id()
485
return self._tree.inventory.path2id(path)
487
def final_file_id(self, trans_id):
488
"""Determine the file id after any changes are applied, or None.
490
None indicates that the file will not be versioned after changes are
494
# there is a new id for this file
495
assert self._new_id[trans_id] is not None
496
return self._new_id[trans_id]
498
if trans_id in self._removed_id:
500
return self.tree_file_id(trans_id)
502
def inactive_file_id(self, trans_id):
503
"""Return the inactive file_id associated with a transaction id.
504
That is, the one in the tree or in non_present_ids.
505
The file_id may actually be active, too.
507
file_id = self.tree_file_id(trans_id)
508
if file_id is not None:
510
for key, value in self._non_present_ids.iteritems():
511
if value == trans_id:
514
def final_parent(self, trans_id):
515
"""Determine the parent file_id, after any changes are applied.
517
ROOT_PARENT is returned for the tree root.
520
return self._new_parent[trans_id]
522
return self.get_tree_parent(trans_id)
524
def final_name(self, trans_id):
525
"""Determine the final filename, after all changes are applied."""
527
return self._new_name[trans_id]
530
return os.path.basename(self._tree_id_paths[trans_id])
532
raise NoFinalPath(trans_id, self)
535
"""Return a map of parent: children for known parents.
537
Only new paths and parents of tree files with assigned ids are used.
540
items = list(self._new_parent.iteritems())
541
items.extend((t, self.final_parent(t)) for t in
542
self._tree_id_paths.keys())
543
for trans_id, parent_id in items:
544
if parent_id not in by_parent:
545
by_parent[parent_id] = set()
546
by_parent[parent_id].add(trans_id)
549
def path_changed(self, trans_id):
550
"""Return True if a trans_id's path has changed."""
551
return (trans_id in self._new_name) or (trans_id in self._new_parent)
553
def new_contents(self, trans_id):
554
return (trans_id in self._new_contents)
556
def find_conflicts(self):
557
"""Find any violations of inventory or filesystem invariants"""
558
if self._done is True:
559
raise ReusingTransform()
561
# ensure all children of all existent parents are known
562
# all children of non-existent parents are known, by definition.
563
self._add_tree_children()
564
by_parent = self.by_parent()
565
conflicts.extend(self._unversioned_parents(by_parent))
566
conflicts.extend(self._parent_loops())
567
conflicts.extend(self._duplicate_entries(by_parent))
568
conflicts.extend(self._duplicate_ids())
569
conflicts.extend(self._parent_type_conflicts(by_parent))
570
conflicts.extend(self._improper_versioning())
571
conflicts.extend(self._executability_conflicts())
572
conflicts.extend(self._overwrite_conflicts())
575
def _add_tree_children(self):
576
"""Add all the children of all active parents to the known paths.
578
Active parents are those which gain children, and those which are
579
removed. This is a necessary first step in detecting conflicts.
581
parents = self.by_parent().keys()
582
parents.extend([t for t in self._removed_contents if
583
self.tree_kind(t) == 'directory'])
584
for trans_id in self._removed_id:
585
file_id = self.tree_file_id(trans_id)
586
if file_id is not None:
587
if self._tree.inventory[file_id].kind == 'directory':
588
parents.append(trans_id)
589
elif self.tree_kind(trans_id) == 'directory':
590
parents.append(trans_id)
592
for parent_id in parents:
593
# ensure that all children are registered with the transaction
594
list(self.iter_tree_children(parent_id))
596
def iter_tree_children(self, parent_id):
597
"""Iterate through the entry's tree children, if any"""
599
path = self._tree_id_paths[parent_id]
603
children = os.listdir(self._tree.abspath(path))
605
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
609
for child in children:
610
childpath = joinpath(path, child)
611
if self._tree.is_control_filename(childpath):
613
yield self.trans_id_tree_path(childpath)
615
def has_named_child(self, by_parent, parent_id, name):
617
children = by_parent[parent_id]
620
for child in children:
621
if self.final_name(child) == name:
624
path = self._tree_id_paths[parent_id]
627
childpath = joinpath(path, name)
628
child_id = self._tree_path_ids.get(childpath)
630
return lexists(self._tree.abspath(childpath))
632
if self.final_parent(child_id) != parent_id:
634
if child_id in self._removed_contents:
635
# XXX What about dangling file-ids?
640
def _parent_loops(self):
641
"""No entry should be its own ancestor"""
643
for trans_id in self._new_parent:
646
while parent_id is not ROOT_PARENT:
649
parent_id = self.final_parent(parent_id)
652
if parent_id == trans_id:
653
conflicts.append(('parent loop', trans_id))
654
if parent_id in seen:
658
def _unversioned_parents(self, by_parent):
659
"""If parent directories are versioned, children must be versioned."""
661
for parent_id, children in by_parent.iteritems():
662
if parent_id is ROOT_PARENT:
664
if self.final_file_id(parent_id) is not None:
666
for child_id in children:
667
if self.final_file_id(child_id) is not None:
668
conflicts.append(('unversioned parent', parent_id))
672
def _improper_versioning(self):
673
"""Cannot version a file with no contents, or a bad type.
675
However, existing entries with no contents are okay.
678
for trans_id in self._new_id.iterkeys():
680
kind = self.final_kind(trans_id)
682
conflicts.append(('versioning no contents', trans_id))
684
if not InventoryEntry.versionable_kind(kind):
685
conflicts.append(('versioning bad kind', trans_id, kind))
688
def _executability_conflicts(self):
689
"""Check for bad executability changes.
691
Only versioned files may have their executability set, because
692
1. only versioned entries can have executability under windows
693
2. only files can be executable. (The execute bit on a directory
694
does not indicate searchability)
697
for trans_id in self._new_executability:
698
if self.final_file_id(trans_id) is None:
699
conflicts.append(('unversioned executability', trans_id))
702
non_file = self.final_kind(trans_id) != "file"
706
conflicts.append(('non-file executability', trans_id))
709
def _overwrite_conflicts(self):
710
"""Check for overwrites (not permitted on Win32)"""
712
for trans_id in self._new_contents:
714
self.tree_kind(trans_id)
717
if trans_id not in self._removed_contents:
718
conflicts.append(('overwrite', trans_id,
719
self.final_name(trans_id)))
722
def _duplicate_entries(self, by_parent):
723
"""No directory may have two entries with the same name."""
725
if (self._new_name, self._new_parent) == ({}, {}):
727
for children in by_parent.itervalues():
728
name_ids = [(self.final_name(t), t) for t in children]
729
if not self._case_sensitive_target:
730
name_ids = [(n.lower(), t) for n, t in name_ids]
734
for name, trans_id in name_ids:
736
kind = self.final_kind(trans_id)
739
file_id = self.final_file_id(trans_id)
740
if kind is None and file_id is None:
742
if name == last_name:
743
conflicts.append(('duplicate', last_trans_id, trans_id,
746
last_trans_id = trans_id
749
def _duplicate_ids(self):
750
"""Each inventory id may only be used once"""
752
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
754
active_tree_ids = set((f for f in self._tree.inventory if
755
f not in removed_tree_ids))
756
for trans_id, file_id in self._new_id.iteritems():
757
if file_id in active_tree_ids:
758
old_trans_id = self.trans_id_tree_file_id(file_id)
759
conflicts.append(('duplicate id', old_trans_id, trans_id))
762
def _parent_type_conflicts(self, by_parent):
763
"""parents must have directory 'contents'."""
765
for parent_id, children in by_parent.iteritems():
766
if parent_id is ROOT_PARENT:
768
if not self._any_contents(children):
770
for child in children:
772
self.final_kind(child)
776
kind = self.final_kind(parent_id)
780
conflicts.append(('missing parent', parent_id))
781
elif kind != "directory":
782
conflicts.append(('non-directory parent', parent_id))
785
def _any_contents(self, trans_ids):
786
"""Return true if any of the trans_ids, will have contents."""
787
for trans_id in trans_ids:
789
kind = self.final_kind(trans_id)
795
def _limbo_name(self, trans_id):
796
"""Generate the limbo name of a file"""
797
limbo_name = self._limbo_files.get(trans_id)
798
if limbo_name is not None:
800
parent = self._new_parent.get(trans_id)
801
# if the parent directory is already in limbo (e.g. when building a
802
# tree), choose a limbo name inside the parent, to reduce further
804
use_direct_path = False
805
if self._new_contents.get(parent) == 'directory':
806
filename = self._new_name.get(trans_id)
807
if filename is not None:
808
if parent not in self._limbo_children:
809
self._limbo_children[parent] = set()
810
self._limbo_children_names[parent] = {}
811
use_direct_path = True
812
# the direct path can only be used if no other file has
813
# already taken this pathname, i.e. if the name is unused, or
814
# if it is already associated with this trans_id.
815
elif self._case_sensitive_target:
816
if (self._limbo_children_names[parent].get(filename)
817
in (trans_id, None)):
818
use_direct_path = True
820
for l_filename, l_trans_id in\
821
self._limbo_children_names[parent].iteritems():
822
if l_trans_id == trans_id:
824
if l_filename.lower() == filename.lower():
827
use_direct_path = True
830
limbo_name = pathjoin(self._limbo_files[parent], filename)
831
self._limbo_children[parent].add(trans_id)
832
self._limbo_children_names[parent][filename] = trans_id
834
limbo_name = pathjoin(self._limbodir, trans_id)
835
self._needs_rename.add(trans_id)
836
self._limbo_files[trans_id] = limbo_name
839
def _set_executability(self, path, entry, trans_id):
840
"""Set the executability of versioned files """
841
new_executability = self._new_executability[trans_id]
842
entry.executable = new_executability
843
if supports_executable():
844
abspath = self._tree.abspath(path)
845
current_mode = os.stat(abspath).st_mode
846
if new_executability:
849
to_mode = current_mode | (0100 & ~umask)
850
# Enable x-bit for others only if they can read it.
851
if current_mode & 0004:
852
to_mode |= 0001 & ~umask
853
if current_mode & 0040:
854
to_mode |= 0010 & ~umask
856
to_mode = current_mode & ~0111
857
os.chmod(abspath, to_mode)
859
def _new_entry(self, name, parent_id, file_id):
860
"""Helper function to create a new filesystem entry."""
861
trans_id = self.create_path(name, parent_id)
862
if file_id is not None:
863
self.version_file(file_id, trans_id)
866
def new_file(self, name, parent_id, contents, file_id=None,
868
"""Convenience method to create files.
870
name is the name of the file to create.
871
parent_id is the transaction id of the parent directory of the file.
872
contents is an iterator of bytestrings, which will be used to produce
874
:param file_id: The inventory ID of the file, if it is to be versioned.
875
:param executable: Only valid when a file_id has been supplied.
877
trans_id = self._new_entry(name, parent_id, file_id)
878
# TODO: rather than scheduling a set_executable call,
879
# have create_file create the file with the right mode.
880
self.create_file(contents, trans_id)
881
if executable is not None:
882
self.set_executability(executable, trans_id)
885
def new_directory(self, name, parent_id, file_id=None):
886
"""Convenience method to create directories.
888
name is the name of the directory to create.
889
parent_id is the transaction id of the parent directory of the
891
file_id is the inventory ID of the directory, if it is to be versioned.
893
trans_id = self._new_entry(name, parent_id, file_id)
894
self.create_directory(trans_id)
897
def new_symlink(self, name, parent_id, target, file_id=None):
898
"""Convenience method to create symbolic link.
900
name is the name of the symlink to create.
901
parent_id is the transaction id of the parent directory of the symlink.
902
target is a bytestring of the target of the symlink.
903
file_id is the inventory ID of the file, if it is to be versioned.
905
trans_id = self._new_entry(name, parent_id, file_id)
906
self.create_symlink(target, trans_id)
909
def _affected_ids(self):
910
"""Return the set of transform ids affected by the transform"""
911
trans_ids = set(self._removed_id)
912
trans_ids.update(self._new_id.keys())
913
trans_ids.update(self._removed_contents)
914
trans_ids.update(self._new_contents.keys())
915
trans_ids.update(self._new_executability.keys())
916
trans_ids.update(self._new_name.keys())
917
trans_ids.update(self._new_parent.keys())
920
def _get_file_id_maps(self):
921
"""Return mapping of file_ids to trans_ids in the to and from states"""
922
trans_ids = self._affected_ids()
925
# Build up two dicts: trans_ids associated with file ids in the
926
# FROM state, vs the TO state.
927
for trans_id in trans_ids:
928
from_file_id = self.tree_file_id(trans_id)
929
if from_file_id is not None:
930
from_trans_ids[from_file_id] = trans_id
931
to_file_id = self.final_file_id(trans_id)
932
if to_file_id is not None:
933
to_trans_ids[to_file_id] = trans_id
934
return from_trans_ids, to_trans_ids
936
def _from_file_data(self, from_trans_id, from_versioned, file_id):
937
"""Get data about a file in the from (tree) state
939
Return a (name, parent, kind, executable) tuple
941
from_path = self._tree_id_paths.get(from_trans_id)
943
# get data from working tree if versioned
944
from_entry = self._tree.inventory[file_id]
945
from_name = from_entry.name
946
from_parent = from_entry.parent_id
949
if from_path is None:
950
# File does not exist in FROM state
954
# File exists, but is not versioned. Have to use path-
956
from_name = os.path.basename(from_path)
957
tree_parent = self.get_tree_parent(from_trans_id)
958
from_parent = self.tree_file_id(tree_parent)
959
if from_path is not None:
960
from_kind, from_executable, from_stats = \
961
self._tree._comparison_data(from_entry, from_path)
964
from_executable = False
965
return from_name, from_parent, from_kind, from_executable
967
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
968
"""Get data about a file in the to (target) state
970
Return a (name, parent, kind, executable) tuple
972
to_name = self.final_name(to_trans_id)
974
to_kind = self.final_kind(to_trans_id)
977
to_parent = self.final_file_id(self.final_parent(to_trans_id))
978
if to_trans_id in self._new_executability:
979
to_executable = self._new_executability[to_trans_id]
980
elif to_trans_id == from_trans_id:
981
to_executable = from_executable
983
to_executable = False
984
return to_name, to_parent, to_kind, to_executable
986
def _iter_changes(self):
987
"""Produce output in the same format as Tree._iter_changes.
989
Will produce nonsensical results if invoked while inventory/filesystem
990
conflicts (as reported by TreeTransform.find_conflicts()) are present.
992
This reads the Transform, but only reproduces changes involving a
993
file_id. Files that are not versioned in either of the FROM or TO
994
states are not reflected.
996
final_paths = FinalPaths(self)
997
from_trans_ids, to_trans_ids = self._get_file_id_maps()
999
# Now iterate through all active file_ids
1000
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1002
from_trans_id = from_trans_ids.get(file_id)
1003
# find file ids, and determine versioning state
1004
if from_trans_id is None:
1005
from_versioned = False
1006
from_trans_id = to_trans_ids[file_id]
1008
from_versioned = True
1009
to_trans_id = to_trans_ids.get(file_id)
1010
if to_trans_id is None:
1011
to_versioned = False
1012
to_trans_id = from_trans_id
1016
from_name, from_parent, from_kind, from_executable = \
1017
self._from_file_data(from_trans_id, from_versioned, file_id)
1019
to_name, to_parent, to_kind, to_executable = \
1020
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1022
if not from_versioned:
1025
from_path = self._tree_id_paths.get(from_trans_id)
1026
if not to_versioned:
1029
to_path = final_paths.get_path(to_trans_id)
1030
if from_kind != to_kind:
1032
elif to_kind in ('file', 'symlink') and (
1033
to_trans_id != from_trans_id or
1034
to_trans_id in self._new_contents):
1036
if (not modified and from_versioned == to_versioned and
1037
from_parent==to_parent and from_name == to_name and
1038
from_executable == to_executable):
1040
results.append((file_id, (from_path, to_path), modified,
1041
(from_versioned, to_versioned),
1042
(from_parent, to_parent),
1043
(from_name, to_name),
1044
(from_kind, to_kind),
1045
(from_executable, to_executable)))
1046
return iter(sorted(results, key=lambda x:x[1]))
1048
def get_preview_tree(self):
1049
"""Return a tree representing the result of the transform.
1051
This tree only supports the subset of Tree functionality required
1052
by show_diff_trees. It must only be compared to tt._tree.
1054
return _PreviewTree(self)
1057
class TreeTransform(TreeTransformBase):
1058
"""Represent a tree transformation.
1060
This object is designed to support incremental generation of the transform,
1063
However, it gives optimum performance when parent directories are created
1064
before their contents. The transform is then able to put child files
1065
directly in their parent directory, avoiding later renames.
1067
It is easy to produce malformed transforms, but they are generally
1068
harmless. Attempting to apply a malformed transform will cause an
1069
exception to be raised before any modifications are made to the tree.
1071
Many kinds of malformed transforms can be corrected with the
1072
resolve_conflicts function. The remaining ones indicate programming error,
1073
such as trying to create a file with no path.
1075
Two sets of file creation methods are supplied. Convenience methods are:
1080
These are composed of the low-level methods:
1082
* create_file or create_directory or create_symlink
1086
Transform/Transaction ids
1087
-------------------------
1088
trans_ids are temporary ids assigned to all files involved in a transform.
1089
It's possible, even common, that not all files in the Tree have trans_ids.
1091
trans_ids are used because filenames and file_ids are not good enough
1092
identifiers; filenames change, and not all files have file_ids. File-ids
1093
are also associated with trans-ids, so that moving a file moves its
1096
trans_ids are only valid for the TreeTransform that generated them.
1100
Limbo is a temporary directory use to hold new versions of files.
1101
Files are added to limbo by create_file, create_directory, create_symlink,
1102
and their convenience variants (new_*). Files may be removed from limbo
1103
using cancel_creation. Files are renamed from limbo into their final
1104
location as part of TreeTransform.apply
1106
Limbo must be cleaned up, by either calling TreeTransform.apply or
1107
calling TreeTransform.finalize.
1109
Files are placed into limbo inside their parent directories, where
1110
possible. This reduces subsequent renames, and makes operations involving
1111
lots of files faster. This optimization is only possible if the parent
1112
directory is created *before* creating any of its children, so avoid
1113
creating children before parents, where possible.
1117
This temporary directory is used by _FileMover for storing files that are
1118
about to be deleted. In case of rollback, the files will be restored.
1119
FileMover does not delete files until it is sure that a rollback will not
1122
def __init__(self, tree, pb=DummyProgress()):
1123
"""Note: a tree_write lock is taken on the tree.
1125
Use TreeTransform.finalize() to release the lock (can be omitted if
1126
TreeTransform.apply() called).
1128
tree.lock_tree_write()
1131
control_files = tree._control_files
1132
limbodir = urlutils.local_path_from_url(
1133
control_files.controlfilename('limbo'))
1137
if e.errno == errno.EEXIST:
1138
raise ExistingLimbo(limbodir)
1139
self._deletiondir = urlutils.local_path_from_url(
1140
control_files.controlfilename('pending-deletion'))
1142
os.mkdir(self._deletiondir)
1144
if e.errno == errno.EEXIST:
1145
raise errors.ExistingPendingDeletion(self._deletiondir)
1150
TreeTransformBase.__init__(self, tree, limbodir, pb,
1151
tree.case_sensitive)
1153
def apply(self, no_conflicts=False, _mover=None):
1154
"""Apply all changes to the inventory and filesystem.
1156
If filesystem or inventory conflicts are present, MalformedTransform
1159
If apply succeeds, finalize is not necessary.
1161
:param no_conflicts: if True, the caller guarantees there are no
1162
conflicts, so no check is made.
1163
:param _mover: Supply an alternate FileMover, for testing
1165
if not no_conflicts:
1166
conflicts = self.find_conflicts()
1167
if len(conflicts) != 0:
1168
raise MalformedTransform(conflicts=conflicts)
1169
inv = self._tree.inventory
1170
inventory_delta = []
1171
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1174
mover = _FileMover()
1178
child_pb.update('Apply phase', 0, 2)
1179
self._apply_removals(inv, inventory_delta, mover)
1180
child_pb.update('Apply phase', 1, 2)
1181
modified_paths = self._apply_insertions(inv, inventory_delta,
1187
mover.apply_deletions()
1190
self._tree.apply_inventory_delta(inventory_delta)
1193
return _TransformResults(modified_paths, self.rename_count)
1195
def _apply_removals(self, inv, inventory_delta, mover):
1196
"""Perform tree operations that remove directory/inventory names.
1198
That is, delete files that are to be deleted, and put any files that
1199
need renaming into limbo. This must be done in strict child-to-parent
1202
tree_paths = list(self._tree_path_ids.iteritems())
1203
tree_paths.sort(reverse=True)
1204
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1206
for num, data in enumerate(tree_paths):
1207
path, trans_id = data
1208
child_pb.update('removing file', num, len(tree_paths))
1209
full_path = self._tree.abspath(path)
1210
if trans_id in self._removed_contents:
1211
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1213
elif trans_id in self._new_name or trans_id in \
1216
mover.rename(full_path, self._limbo_name(trans_id))
1218
if e.errno != errno.ENOENT:
1221
self.rename_count += 1
1222
if trans_id in self._removed_id:
1223
if trans_id == self._new_root:
1224
file_id = self._tree.get_root_id()
1226
file_id = self.tree_file_id(trans_id)
1227
if file_id is not None:
1228
inventory_delta.append((path, None, file_id, None))
1232
def _apply_insertions(self, inv, inventory_delta, mover):
1233
"""Perform tree operations that insert directory/inventory names.
1235
That is, create any files that need to be created, and restore from
1236
limbo any files that needed renaming. This must be done in strict
1237
parent-to-child order.
1239
new_paths = self.new_paths()
1241
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1244
for num, (path, trans_id) in enumerate(new_paths):
1246
child_pb.update('adding file', num, len(new_paths))
1248
kind = self._new_contents[trans_id]
1250
kind = contents = None
1251
if trans_id in self._new_contents or \
1252
self.path_changed(trans_id):
1253
full_path = self._tree.abspath(path)
1254
if trans_id in self._needs_rename:
1256
mover.rename(self._limbo_name(trans_id), full_path)
1258
# We may be renaming a dangling inventory id
1259
if e.errno != errno.ENOENT:
1262
self.rename_count += 1
1263
if trans_id in self._new_contents:
1264
modified_paths.append(full_path)
1265
completed_new.append(trans_id)
1267
if trans_id in self._new_id:
1269
kind = file_kind(self._tree.abspath(path))
1270
if trans_id in self._new_reference_revision:
1271
new_entry = inventory.TreeReference(
1272
self._new_id[trans_id],
1273
self._new_name[trans_id],
1274
self.final_file_id(self._new_parent[trans_id]),
1275
None, self._new_reference_revision[trans_id])
1277
new_entry = inventory.make_entry(kind,
1278
self.final_name(trans_id),
1279
self.final_file_id(self.final_parent(trans_id)),
1280
self._new_id[trans_id])
1282
if trans_id in self._new_name or trans_id in\
1283
self._new_parent or\
1284
trans_id in self._new_executability:
1285
file_id = self.final_file_id(trans_id)
1286
if file_id is not None:
1287
entry = inv[file_id]
1288
new_entry = entry.copy()
1290
if trans_id in self._new_name or trans_id in\
1292
if new_entry is not None:
1293
new_entry.name = self.final_name(trans_id)
1294
parent = self.final_parent(trans_id)
1295
parent_id = self.final_file_id(parent)
1296
new_entry.parent_id = parent_id
1298
if trans_id in self._new_executability:
1299
self._set_executability(path, new_entry, trans_id)
1300
if new_entry is not None:
1301
if new_entry.file_id in inv:
1302
old_path = inv.id2path(new_entry.file_id)
1305
inventory_delta.append((old_path, path,
1310
for trans_id in completed_new:
1311
del self._new_contents[trans_id]
1312
return modified_paths
1315
class TransformPreview(TreeTransformBase):
1316
"""A TreeTransform for generating preview trees.
1318
Unlike TreeTransform, this version works when the input tree is a
1319
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1320
unversioned files in the input tree.
1323
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1324
limbodir = tempfile.mkdtemp()
1325
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1327
def canonical_path(self, path):
1330
def tree_kind(self, trans_id):
1331
path = self._tree_id_paths.get(trans_id)
1333
raise NoSuchFile(None)
1334
file_id = self._tree.path2id(path)
1335
return self._tree.kind(file_id)
1337
def _set_mode(self, trans_id, mode_id, typefunc):
1338
"""Set the mode of new file contents.
1339
The mode_id is the existing file to get the mode from (often the same
1340
as trans_id). The operation is only performed if there's a mode match
1341
according to typefunc.
1343
# is it ok to ignore this? probably
1346
def iter_tree_children(self, parent_id):
1347
"""Iterate through the entry's tree children, if any"""
1349
path = self._tree_id_paths[parent_id]
1352
file_id = self.tree_file_id(parent_id)
1353
for child in self._tree.inventory[file_id].children.iterkeys():
1354
childpath = joinpath(path, child)
1355
yield self.trans_id_tree_path(childpath)
1358
class _PreviewTree(object):
1359
"""Partial implementation of Tree to support show_diff_trees"""
1361
def __init__(self, transform):
1362
self._transform = transform
1364
def lock_read(self):
1365
# Perhaps in theory, this should lock the TreeTransform?
1371
def _iter_changes(self, from_tree, include_unchanged=False,
1372
specific_files=None, pb=None, extra_trees=None,
1373
require_versioned=True, want_unversioned=False):
1374
"""See InterTree._iter_changes.
1376
This implementation does not support include_unchanged, specific_files,
1377
or want_unversioned. extra_trees, require_versioned, and pb are
1380
if from_tree is not self._transform._tree:
1381
raise ValueError('from_tree must be transform source tree.')
1382
if include_unchanged:
1383
raise ValueError('include_unchanged is not supported')
1384
if specific_files is not None:
1385
raise ValueError('specific_files is not supported')
1386
if want_unversioned:
1387
raise ValueError('want_unversioned is not supported')
1388
return self._transform._iter_changes()
1390
def kind(self, file_id):
1391
trans_id = self._transform.trans_id_file_id(file_id)
1392
return self._transform.final_kind(trans_id)
1394
def get_file_mtime(self, file_id, path=None):
1395
"""See Tree.get_file_mtime"""
1396
trans_id = self._transform.trans_id_file_id(file_id)
1397
name = self._transform._limbo_name(trans_id)
1398
return os.stat(name).st_mtime
1400
def get_file(self, file_id):
1401
"""See Tree.get_file"""
1402
trans_id = self._transform.trans_id_file_id(file_id)
1403
name = self._transform._limbo_name(trans_id)
1404
return open(name, 'rb')
1406
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1407
"""See Tree.paths2ids"""
1411
def joinpath(parent, child):
1412
"""Join tree-relative paths, handling the tree root specially"""
1413
if parent is None or parent == "":
1416
return pathjoin(parent, child)
1419
class FinalPaths(object):
1420
"""Make path calculation cheap by memoizing paths.
1422
The underlying tree must not be manipulated between calls, or else
1423
the results will likely be incorrect.
1425
def __init__(self, transform):
1426
object.__init__(self)
1427
self._known_paths = {}
1428
self.transform = transform
1430
def _determine_path(self, trans_id):
1431
if trans_id == self.transform.root:
1433
name = self.transform.final_name(trans_id)
1434
parent_id = self.transform.final_parent(trans_id)
1435
if parent_id == self.transform.root:
1438
return pathjoin(self.get_path(parent_id), name)
1440
def get_path(self, trans_id):
1441
"""Find the final path associated with a trans_id"""
1442
if trans_id not in self._known_paths:
1443
self._known_paths[trans_id] = self._determine_path(trans_id)
1444
return self._known_paths[trans_id]
1447
def topology_sorted_ids(tree):
1448
"""Determine the topological order of the ids in a tree"""
1449
file_ids = list(tree)
1450
file_ids.sort(key=tree.id2path)
1454
def build_tree(tree, wt, accelerator_tree=None):
1455
"""Create working tree for a branch, using a TreeTransform.
1457
This function should be used on empty trees, having a tree root at most.
1458
(see merge and revert functionality for working with existing trees)
1460
Existing files are handled like so:
1462
- Existing bzrdirs take precedence over creating new items. They are
1463
created as '%s.diverted' % name.
1464
- Otherwise, if the content on disk matches the content we are building,
1465
it is silently replaced.
1466
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1468
:param tree: The tree to convert wt into a copy of
1469
:param wt: The working tree that files will be placed into
1470
:param accelerator_tree: A tree which can be used for retrieving file
1471
contents more quickly than tree itself, i.e. a workingtree. tree
1472
will be used for cases where accelerator_tree's content is different.
1474
wt.lock_tree_write()
1478
if accelerator_tree is not None:
1479
accelerator_tree.lock_read()
1481
return _build_tree(tree, wt, accelerator_tree)
1483
if accelerator_tree is not None:
1484
accelerator_tree.unlock()
1491
def _build_tree(tree, wt, accelerator_tree):
1492
"""See build_tree."""
1493
if len(wt.inventory) > 1: # more than just a root
1494
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1496
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1497
pp = ProgressPhase("Build phase", 2, top_pb)
1498
if tree.inventory.root is not None:
1499
# This is kind of a hack: we should be altering the root
1500
# as part of the regular tree shape diff logic.
1501
# The conditional test here is to avoid doing an
1502
# expensive operation (flush) every time the root id
1503
# is set within the tree, nor setting the root and thus
1504
# marking the tree as dirty, because we use two different
1505
# idioms here: tree interfaces and inventory interfaces.
1506
if wt.get_root_id() != tree.get_root_id():
1507
wt.set_root_id(tree.get_root_id())
1509
tt = TreeTransform(wt)
1513
file_trans_id[wt.get_root_id()] = \
1514
tt.trans_id_tree_file_id(wt.get_root_id())
1515
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1517
deferred_contents = []
1518
for num, (tree_path, entry) in \
1519
enumerate(tree.inventory.iter_entries_by_dir()):
1520
pb.update("Building tree", num - len(deferred_contents),
1521
len(tree.inventory))
1522
if entry.parent_id is None:
1525
file_id = entry.file_id
1526
target_path = wt.abspath(tree_path)
1528
kind = file_kind(target_path)
1532
if kind == "directory":
1534
bzrdir.BzrDir.open(target_path)
1535
except errors.NotBranchError:
1539
if (file_id not in divert and
1540
_content_match(tree, entry, file_id, kind,
1542
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1543
if kind == 'directory':
1545
if entry.parent_id not in file_trans_id:
1546
raise AssertionError(
1547
'entry %s parent id %r is not in file_trans_id %r'
1548
% (entry, entry.parent_id, file_trans_id))
1549
parent_id = file_trans_id[entry.parent_id]
1550
if entry.kind == 'file':
1551
# We *almost* replicate new_by_entry, so that we can defer
1552
# getting the file text, and get them all at once.
1553
trans_id = tt.create_path(entry.name, parent_id)
1554
file_trans_id[file_id] = trans_id
1555
tt.version_file(entry.file_id, trans_id)
1556
executable = tree.is_executable(entry.file_id, tree_path)
1557
if executable is not None:
1558
tt.set_executability(executable, trans_id)
1559
deferred_contents.append((entry.file_id, trans_id))
1561
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1564
new_trans_id = file_trans_id[file_id]
1565
old_parent = tt.trans_id_tree_path(tree_path)
1566
_reparent_children(tt, old_parent, new_trans_id)
1567
for num, (trans_id, bytes) in enumerate(
1568
_iter_files_bytes_accelerated(tree, accelerator_tree,
1569
deferred_contents)):
1570
tt.create_file(bytes, trans_id)
1571
pb.update('Adding file contents',
1572
(num + len(tree.inventory) - len(deferred_contents)),
1573
len(tree.inventory))
1577
divert_trans = set(file_trans_id[f] for f in divert)
1578
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1579
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1580
conflicts = cook_conflicts(raw_conflicts, tt)
1581
for conflict in conflicts:
1584
wt.add_conflicts(conflicts)
1585
except errors.UnsupportedOperation:
1587
result = tt.apply(no_conflicts=True)
1594
def _iter_files_bytes_accelerated(tree, accelerator_tree, desired_files):
1595
if accelerator_tree is None:
1596
new_desired_files = desired_files
1598
iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
1599
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1601
new_desired_files = []
1602
for file_id, identifier in desired_files:
1603
accelerator_path = unchanged.get(file_id)
1604
if accelerator_path is None:
1605
new_desired_files.append((file_id, identifier))
1607
contents = accelerator_tree.get_file(file_id, accelerator_path)
1610
contents_bytes = (contents.read(),)
1613
yield identifier, contents_bytes
1614
for result in tree.iter_files_bytes(new_desired_files):
1618
def _reparent_children(tt, old_parent, new_parent):
1619
for child in tt.iter_tree_children(old_parent):
1620
tt.adjust_path(tt.final_name(child), new_parent, child)
1622
def _reparent_transform_children(tt, old_parent, new_parent):
1623
by_parent = tt.by_parent()
1624
for child in by_parent[old_parent]:
1625
tt.adjust_path(tt.final_name(child), new_parent, child)
1627
def _content_match(tree, entry, file_id, kind, target_path):
1628
if entry.kind != kind:
1630
if entry.kind == "directory":
1632
if entry.kind == "file":
1633
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1635
elif entry.kind == "symlink":
1636
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1641
def resolve_checkout(tt, conflicts, divert):
1642
new_conflicts = set()
1643
for c_type, conflict in ((c[0], c) for c in conflicts):
1644
# Anything but a 'duplicate' would indicate programmer error
1645
assert c_type == 'duplicate', c_type
1646
# Now figure out which is new and which is old
1647
if tt.new_contents(conflict[1]):
1648
new_file = conflict[1]
1649
old_file = conflict[2]
1651
new_file = conflict[2]
1652
old_file = conflict[1]
1654
# We should only get here if the conflict wasn't completely
1656
final_parent = tt.final_parent(old_file)
1657
if new_file in divert:
1658
new_name = tt.final_name(old_file)+'.diverted'
1659
tt.adjust_path(new_name, final_parent, new_file)
1660
new_conflicts.add((c_type, 'Diverted to',
1661
new_file, old_file))
1663
new_name = tt.final_name(old_file)+'.moved'
1664
tt.adjust_path(new_name, final_parent, old_file)
1665
new_conflicts.add((c_type, 'Moved existing file to',
1666
old_file, new_file))
1667
return new_conflicts
1670
def new_by_entry(tt, entry, parent_id, tree):
1671
"""Create a new file according to its inventory entry"""
1675
contents = tree.get_file(entry.file_id).readlines()
1676
executable = tree.is_executable(entry.file_id)
1677
return tt.new_file(name, parent_id, contents, entry.file_id,
1679
elif kind in ('directory', 'tree-reference'):
1680
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1681
if kind == 'tree-reference':
1682
tt.set_tree_reference(entry.reference_revision, trans_id)
1684
elif kind == 'symlink':
1685
target = tree.get_symlink_target(entry.file_id)
1686
return tt.new_symlink(name, parent_id, target, entry.file_id)
1688
raise errors.BadFileKindError(name, kind)
1691
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1692
"""Create new file contents according to an inventory entry."""
1693
if entry.kind == "file":
1695
lines = tree.get_file(entry.file_id).readlines()
1696
tt.create_file(lines, trans_id, mode_id=mode_id)
1697
elif entry.kind == "symlink":
1698
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1699
elif entry.kind == "directory":
1700
tt.create_directory(trans_id)
1703
def create_entry_executability(tt, entry, trans_id):
1704
"""Set the executability of a trans_id according to an inventory entry"""
1705
if entry.kind == "file":
1706
tt.set_executability(entry.executable, trans_id)
1709
@deprecated_function(zero_fifteen)
1710
def find_interesting(working_tree, target_tree, filenames):
1711
"""Find the ids corresponding to specified filenames.
1713
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1715
working_tree.lock_read()
1717
target_tree.lock_read()
1719
return working_tree.paths2ids(filenames, [target_tree])
1721
target_tree.unlock()
1723
working_tree.unlock()
1726
@deprecated_function(zero_ninety)
1727
def change_entry(tt, file_id, working_tree, target_tree,
1728
trans_id_file_id, backups, trans_id, by_parent):
1729
"""Replace a file_id's contents with those from a target tree."""
1730
if file_id is None and target_tree is None:
1731
# skip the logic altogether in the deprecation test
1733
e_trans_id = trans_id_file_id(file_id)
1734
entry = target_tree.inventory[file_id]
1735
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1738
mode_id = e_trans_id
1741
tt.delete_contents(e_trans_id)
1743
parent_trans_id = trans_id_file_id(entry.parent_id)
1744
backup_name = get_backup_name(entry, by_parent,
1745
parent_trans_id, tt)
1746
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1747
tt.unversion_file(e_trans_id)
1748
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1749
tt.version_file(file_id, e_trans_id)
1750
trans_id[file_id] = e_trans_id
1751
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1752
create_entry_executability(tt, entry, e_trans_id)
1755
tt.set_executability(entry.executable, e_trans_id)
1756
if tt.final_name(e_trans_id) != entry.name:
1759
parent_id = tt.final_parent(e_trans_id)
1760
parent_file_id = tt.final_file_id(parent_id)
1761
if parent_file_id != entry.parent_id:
1766
parent_trans_id = trans_id_file_id(entry.parent_id)
1767
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1770
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1771
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1774
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1775
"""Produce a backup-style name that appears to be available"""
1779
yield "%s.~%d~" % (name, counter)
1781
for new_name in name_gen():
1782
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1786
def _entry_changes(file_id, entry, working_tree):
1787
"""Determine in which ways the inventory entry has changed.
1789
Returns booleans: has_contents, content_mod, meta_mod
1790
has_contents means there are currently contents, but they differ
1791
contents_mod means contents need to be modified
1792
meta_mod means the metadata needs to be modified
1794
cur_entry = working_tree.inventory[file_id]
1796
working_kind = working_tree.kind(file_id)
1799
has_contents = False
1802
if has_contents is True:
1803
if entry.kind != working_kind:
1804
contents_mod, meta_mod = True, False
1806
cur_entry._read_tree_state(working_tree.id2path(file_id),
1808
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1809
cur_entry._forget_tree_state()
1810
return has_contents, contents_mod, meta_mod
1813
def revert(working_tree, target_tree, filenames, backups=False,
1814
pb=DummyProgress(), change_reporter=None):
1815
"""Revert a working tree's contents to those of a target tree."""
1816
target_tree.lock_read()
1817
tt = TreeTransform(working_tree, pb)
1819
pp = ProgressPhase("Revert phase", 3, pb)
1821
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1823
merge_modified = _alter_files(working_tree, target_tree, tt,
1824
child_pb, filenames, backups)
1828
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1830
raw_conflicts = resolve_conflicts(tt, child_pb,
1831
lambda t, c: conflict_pass(t, c, target_tree))
1834
conflicts = cook_conflicts(raw_conflicts, tt)
1836
change_reporter = delta._ChangeReporter(
1837
unversioned_filter=working_tree.is_ignored)
1838
delta.report_changes(tt._iter_changes(), change_reporter)
1839
for conflict in conflicts:
1843
working_tree.set_merge_modified(merge_modified)
1845
target_tree.unlock()
1851
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1853
merge_modified = working_tree.merge_modified()
1854
change_list = target_tree._iter_changes(working_tree,
1855
specific_files=specific_files, pb=pb)
1856
if target_tree.inventory.root is None:
1863
for id_num, (file_id, path, changed_content, versioned, parent, name,
1864
kind, executable) in enumerate(change_list):
1865
if skip_root and file_id[0] is not None and parent[0] is None:
1867
trans_id = tt.trans_id_file_id(file_id)
1870
keep_content = False
1871
if kind[0] == 'file' and (backups or kind[1] is None):
1872
wt_sha1 = working_tree.get_file_sha1(file_id)
1873
if merge_modified.get(file_id) != wt_sha1:
1874
# acquire the basis tree lazily to prevent the
1875
# expense of accessing it when it's not needed ?
1876
# (Guessing, RBC, 200702)
1877
if basis_tree is None:
1878
basis_tree = working_tree.basis_tree()
1879
basis_tree.lock_read()
1880
if file_id in basis_tree:
1881
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1883
elif kind[1] is None and not versioned[1]:
1885
if kind[0] is not None:
1886
if not keep_content:
1887
tt.delete_contents(trans_id)
1888
elif kind[1] is not None:
1889
parent_trans_id = tt.trans_id_file_id(parent[0])
1890
by_parent = tt.by_parent()
1891
backup_name = _get_backup_name(name[0], by_parent,
1892
parent_trans_id, tt)
1893
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1894
new_trans_id = tt.create_path(name[0], parent_trans_id)
1895
if versioned == (True, True):
1896
tt.unversion_file(trans_id)
1897
tt.version_file(file_id, new_trans_id)
1898
# New contents should have the same unix perms as old
1901
trans_id = new_trans_id
1902
if kind[1] == 'directory':
1903
tt.create_directory(trans_id)
1904
elif kind[1] == 'symlink':
1905
tt.create_symlink(target_tree.get_symlink_target(file_id),
1907
elif kind[1] == 'file':
1908
deferred_files.append((file_id, (trans_id, mode_id)))
1909
if basis_tree is None:
1910
basis_tree = working_tree.basis_tree()
1911
basis_tree.lock_read()
1912
new_sha1 = target_tree.get_file_sha1(file_id)
1913
if (file_id in basis_tree and new_sha1 ==
1914
basis_tree.get_file_sha1(file_id)):
1915
if file_id in merge_modified:
1916
del merge_modified[file_id]
1918
merge_modified[file_id] = new_sha1
1920
# preserve the execute bit when backing up
1921
if keep_content and executable[0] == executable[1]:
1922
tt.set_executability(executable[1], trans_id)
1924
assert kind[1] is None
1925
if versioned == (False, True):
1926
tt.version_file(file_id, trans_id)
1927
if versioned == (True, False):
1928
tt.unversion_file(trans_id)
1929
if (name[1] is not None and
1930
(name[0] != name[1] or parent[0] != parent[1])):
1932
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1933
if executable[0] != executable[1] and kind[1] == "file":
1934
tt.set_executability(executable[1], trans_id)
1935
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1937
tt.create_file(bytes, trans_id, mode_id)
1939
if basis_tree is not None:
1941
return merge_modified
1944
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1945
"""Make many conflict-resolution attempts, but die if they fail"""
1946
if pass_func is None:
1947
pass_func = conflict_pass
1948
new_conflicts = set()
1951
pb.update('Resolution pass', n+1, 10)
1952
conflicts = tt.find_conflicts()
1953
if len(conflicts) == 0:
1954
return new_conflicts
1955
new_conflicts.update(pass_func(tt, conflicts))
1956
raise MalformedTransform(conflicts=conflicts)
1961
def conflict_pass(tt, conflicts, path_tree=None):
1962
"""Resolve some classes of conflicts.
1964
:param tt: The transform to resolve conflicts in
1965
:param conflicts: The conflicts to resolve
1966
:param path_tree: A Tree to get supplemental paths from
1968
new_conflicts = set()
1969
for c_type, conflict in ((c[0], c) for c in conflicts):
1970
if c_type == 'duplicate id':
1971
tt.unversion_file(conflict[1])
1972
new_conflicts.add((c_type, 'Unversioned existing file',
1973
conflict[1], conflict[2], ))
1974
elif c_type == 'duplicate':
1975
# files that were renamed take precedence
1976
final_parent = tt.final_parent(conflict[1])
1977
if tt.path_changed(conflict[1]):
1978
existing_file, new_file = conflict[2], conflict[1]
1980
existing_file, new_file = conflict[1], conflict[2]
1981
new_name = tt.final_name(existing_file)+'.moved'
1982
tt.adjust_path(new_name, final_parent, existing_file)
1983
new_conflicts.add((c_type, 'Moved existing file to',
1984
existing_file, new_file))
1985
elif c_type == 'parent loop':
1986
# break the loop by undoing one of the ops that caused the loop
1988
while not tt.path_changed(cur):
1989
cur = tt.final_parent(cur)
1990
new_conflicts.add((c_type, 'Cancelled move', cur,
1991
tt.final_parent(cur),))
1992
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1994
elif c_type == 'missing parent':
1995
trans_id = conflict[1]
1997
tt.cancel_deletion(trans_id)
1998
new_conflicts.add(('deleting parent', 'Not deleting',
2001
tt.create_directory(trans_id)
2002
new_conflicts.add((c_type, 'Created directory', trans_id))
2004
tt.final_name(trans_id)
2006
if path_tree is not None:
2007
file_id = tt.final_file_id(trans_id)
2008
entry = path_tree.inventory[file_id]
2009
parent_trans_id = tt.trans_id_file_id(entry.parent_id)
2010
tt.adjust_path(entry.name, parent_trans_id, trans_id)
2011
elif c_type == 'unversioned parent':
2012
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
2013
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2014
elif c_type == 'non-directory parent':
2015
parent_id = conflict[1]
2016
parent_parent = tt.final_parent(parent_id)
2017
parent_name = tt.final_name(parent_id)
2018
parent_file_id = tt.final_file_id(parent_id)
2019
new_parent_id = tt.new_directory(parent_name + '.new',
2020
parent_parent, parent_file_id)
2021
_reparent_transform_children(tt, parent_id, new_parent_id)
2022
tt.unversion_file(parent_id)
2023
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2024
return new_conflicts
2027
def cook_conflicts(raw_conflicts, tt):
2028
"""Generate a list of cooked conflicts, sorted by file path"""
2029
from bzrlib.conflicts import Conflict
2030
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2031
return sorted(conflict_iter, key=Conflict.sort_key)
2034
def iter_cook_conflicts(raw_conflicts, tt):
2035
from bzrlib.conflicts import Conflict
2037
for conflict in raw_conflicts:
2038
c_type = conflict[0]
2039
action = conflict[1]
2040
modified_path = fp.get_path(conflict[2])
2041
modified_id = tt.final_file_id(conflict[2])
2042
if len(conflict) == 3:
2043
yield Conflict.factory(c_type, action=action, path=modified_path,
2044
file_id=modified_id)
2047
conflicting_path = fp.get_path(conflict[3])
2048
conflicting_id = tt.final_file_id(conflict[3])
2049
yield Conflict.factory(c_type, action=action, path=modified_path,
2050
file_id=modified_id,
2051
conflict_path=conflicting_path,
2052
conflict_file_id=conflicting_id)
2055
class _FileMover(object):
2056
"""Moves and deletes files for TreeTransform, tracking operations"""
2059
self.past_renames = []
2060
self.pending_deletions = []
2062
def rename(self, from_, to):
2063
"""Rename a file from one path to another. Functions like os.rename"""
2065
os.rename(from_, to)
2067
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2068
raise errors.FileExists(to, str(e))
2070
self.past_renames.append((from_, to))
2072
def pre_delete(self, from_, to):
2073
"""Rename a file out of the way and mark it for deletion.
2075
Unlike os.unlink, this works equally well for files and directories.
2076
:param from_: The current file path
2077
:param to: A temporary path for the file
2079
self.rename(from_, to)
2080
self.pending_deletions.append(to)
2083
"""Reverse all renames that have been performed"""
2084
for from_, to in reversed(self.past_renames):
2085
os.rename(to, from_)
2086
# after rollback, don't reuse _FileMover
2088
pending_deletions = None
2090
def apply_deletions(self):
2091
"""Apply all marked deletions"""
2092
for path in self.pending_deletions:
2094
# after apply_deletions, don't reuse _FileMover
2096
pending_deletions = None
added
removed
bzrlib/transform.py
