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
84
self._deletiondir = None
86
# mapping of trans_id -> new basename
88
# mapping of trans_id -> new parent trans_id
90
# mapping of trans_id with new contents -> new file_kind
91
self._new_contents = {}
92
# A mapping of transform ids to their limbo filename
93
self._limbo_files = {}
94
# A mapping of transform ids to a set of the transform ids of children
95
# that their limbo directory has
96
self._limbo_children = {}
97
# Map transform ids to maps of child filename to child transform id
98
self._limbo_children_names = {}
99
# List of transform ids that need to be renamed from limbo into place
100
self._needs_rename = set()
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 file_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
# Cache of realpath results, to speed up canonical_path
121
# Cache of relpath results, to speed up canonical_path
123
# The trans_id that will be used as the tree root
124
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
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
134
def __get_root(self):
135
return self._new_root
137
root = property(__get_root)
140
"""Release the working tree lock, if held, clean up limbo dir.
142
This is required if apply has not been invoked, but can be invoked
145
if self._tree is None:
148
entries = [(self._limbo_name(t), t, k) for t, k in
149
self._new_contents.iteritems()]
150
entries.sort(reverse=True)
151
for path, trans_id, kind in entries:
152
if kind == "directory":
157
os.rmdir(self._limbodir)
159
# We don't especially care *why* the dir is immortal.
160
raise ImmortalLimbo(self._limbodir)
162
if self._deletiondir is not None:
163
os.rmdir(self._deletiondir)
165
raise errors.ImmortalPendingDeletion(self._deletiondir)
170
def _assign_id(self):
171
"""Produce a new tranform id"""
172
new_id = "new-%s" % self._id_number
176
def create_path(self, name, parent):
177
"""Assign a transaction id to a new path"""
178
trans_id = self._assign_id()
179
unique_add(self._new_name, trans_id, name)
180
unique_add(self._new_parent, trans_id, parent)
183
def adjust_path(self, name, parent, trans_id):
184
"""Change the path that is assigned to a transaction id."""
185
if trans_id == self._new_root:
187
previous_parent = self._new_parent.get(trans_id)
188
previous_name = self._new_name.get(trans_id)
189
self._new_name[trans_id] = name
190
self._new_parent[trans_id] = parent
191
if (trans_id in self._limbo_files and
192
trans_id not in self._needs_rename):
193
self._rename_in_limbo([trans_id])
194
self._limbo_children[previous_parent].remove(trans_id)
195
del self._limbo_children_names[previous_parent][previous_name]
197
def _rename_in_limbo(self, trans_ids):
198
"""Fix limbo names so that the right final path is produced.
200
This means we outsmarted ourselves-- we tried to avoid renaming
201
these files later by creating them with their final names in their
202
final parents. But now the previous name or parent is no longer
203
suitable, so we have to rename them.
205
Even for trans_ids that have no new contents, we must remove their
206
entries from _limbo_files, because they are now stale.
208
for trans_id in trans_ids:
209
old_path = self._limbo_files.pop(trans_id)
210
if trans_id not in self._new_contents:
212
new_path = self._limbo_name(trans_id)
213
os.rename(old_path, new_path)
215
def adjust_root_path(self, name, parent):
216
"""Emulate moving the root by moving all children, instead.
218
We do this by undoing the association of root's transaction id with the
219
current tree. This allows us to create a new directory with that
220
transaction id. We unversion the root directory and version the
221
physically new directory, and hope someone versions the tree root
224
old_root = self._new_root
225
old_root_file_id = self.final_file_id(old_root)
226
# force moving all children of root
227
for child_id in self.iter_tree_children(old_root):
228
if child_id != parent:
229
self.adjust_path(self.final_name(child_id),
230
self.final_parent(child_id), child_id)
231
file_id = self.final_file_id(child_id)
232
if file_id is not None:
233
self.unversion_file(child_id)
234
self.version_file(file_id, child_id)
236
# the physical root needs a new transaction id
237
self._tree_path_ids.pop("")
238
self._tree_id_paths.pop(old_root)
239
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
240
if parent == old_root:
241
parent = self._new_root
242
self.adjust_path(name, parent, old_root)
243
self.create_directory(old_root)
244
self.version_file(old_root_file_id, old_root)
245
self.unversion_file(self._new_root)
247
def trans_id_tree_file_id(self, inventory_id):
248
"""Determine the transaction id of a working tree file.
250
This reflects only files that already exist, not ones that will be
251
added by transactions.
253
path = self._tree.inventory.id2path(inventory_id)
254
return self.trans_id_tree_path(path)
256
def trans_id_file_id(self, file_id):
257
"""Determine or set the transaction id associated with a file ID.
258
A new id is only created for file_ids that were never present. If
259
a transaction has been unversioned, it is deliberately still returned.
260
(this will likely lead to an unversioned parent conflict.)
262
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
263
return self._r_new_id[file_id]
264
elif file_id in self._tree.inventory:
265
return self.trans_id_tree_file_id(file_id)
266
elif file_id in self._non_present_ids:
267
return self._non_present_ids[file_id]
269
trans_id = self._assign_id()
270
self._non_present_ids[file_id] = trans_id
273
def canonical_path(self, path):
274
"""Get the canonical tree-relative path"""
275
# don't follow final symlinks
276
abs = self._tree.abspath(path)
277
if abs in self._relpaths:
278
return self._relpaths[abs]
279
dirname, basename = os.path.split(abs)
280
if dirname not in self._realpaths:
281
self._realpaths[dirname] = os.path.realpath(dirname)
282
dirname = self._realpaths[dirname]
283
abs = pathjoin(dirname, basename)
284
if dirname in self._relpaths:
285
relpath = pathjoin(self._relpaths[dirname], basename)
286
relpath = relpath.rstrip('/\\')
288
relpath = self._tree.relpath(abs)
289
self._relpaths[abs] = relpath
292
def trans_id_tree_path(self, path):
293
"""Determine (and maybe set) the transaction ID for a tree path."""
294
path = self.canonical_path(path)
295
if path not in self._tree_path_ids:
296
self._tree_path_ids[path] = self._assign_id()
297
self._tree_id_paths[self._tree_path_ids[path]] = path
298
return self._tree_path_ids[path]
300
def get_tree_parent(self, trans_id):
301
"""Determine id of the parent in the tree."""
302
path = self._tree_id_paths[trans_id]
305
return self.trans_id_tree_path(os.path.dirname(path))
307
def create_file(self, contents, trans_id, mode_id=None):
308
"""Schedule creation of a new file.
312
Contents is an iterator of strings, all of which will be written
313
to the target destination.
315
New file takes the permissions of any existing file with that id,
316
unless mode_id is specified.
318
name = self._limbo_name(trans_id)
322
unique_add(self._new_contents, trans_id, 'file')
324
# Clean up the file, it never got registered so
325
# TreeTransform.finalize() won't clean it up.
330
f.writelines(contents)
333
self._set_mode(trans_id, mode_id, S_ISREG)
335
def _set_mode(self, trans_id, mode_id, typefunc):
336
"""Set the mode of new file contents.
337
The mode_id is the existing file to get the mode from (often the same
338
as trans_id). The operation is only performed if there's a mode match
339
according to typefunc.
344
old_path = self._tree_id_paths[mode_id]
348
mode = os.stat(self._tree.abspath(old_path)).st_mode
350
if e.errno == errno.ENOENT:
355
os.chmod(self._limbo_name(trans_id), mode)
357
def create_hardlink(self, path, trans_id):
358
"""Schedule creation of a hard link"""
359
name = self._limbo_name(trans_id)
363
if e.errno != errno.EPERM:
365
raise errors.HardLinkNotSupported(path)
367
unique_add(self._new_contents, trans_id, 'file')
369
# Clean up the file, it never got registered so
370
# TreeTransform.finalize() won't clean it up.
374
def create_directory(self, trans_id):
375
"""Schedule creation of a new directory.
377
See also new_directory.
379
os.mkdir(self._limbo_name(trans_id))
380
unique_add(self._new_contents, trans_id, 'directory')
382
def create_symlink(self, target, trans_id):
383
"""Schedule creation of a new symbolic link.
385
target is a bytestring.
386
See also new_symlink.
389
os.symlink(target, self._limbo_name(trans_id))
390
unique_add(self._new_contents, trans_id, 'symlink')
393
path = FinalPaths(self).get_path(trans_id)
396
raise UnableCreateSymlink(path=path)
398
def cancel_creation(self, trans_id):
399
"""Cancel the creation of new file contents."""
400
del self._new_contents[trans_id]
401
children = self._limbo_children.get(trans_id)
402
# if this is a limbo directory with children, move them before removing
404
if children is not None:
405
self._rename_in_limbo(children)
406
del self._limbo_children[trans_id]
407
del self._limbo_children_names[trans_id]
408
delete_any(self._limbo_name(trans_id))
410
def delete_contents(self, trans_id):
411
"""Schedule the contents of a path entry for deletion"""
412
self.tree_kind(trans_id)
413
self._removed_contents.add(trans_id)
415
def cancel_deletion(self, trans_id):
416
"""Cancel a scheduled deletion"""
417
self._removed_contents.remove(trans_id)
419
def unversion_file(self, trans_id):
420
"""Schedule a path entry to become unversioned"""
421
self._removed_id.add(trans_id)
423
def delete_versioned(self, trans_id):
424
"""Delete and unversion a versioned file"""
425
self.delete_contents(trans_id)
426
self.unversion_file(trans_id)
428
def set_executability(self, executability, trans_id):
429
"""Schedule setting of the 'execute' bit
430
To unschedule, set to None
432
if executability is None:
433
del self._new_executability[trans_id]
435
unique_add(self._new_executability, trans_id, executability)
437
def set_tree_reference(self, revision_id, trans_id):
438
"""Set the reference associated with a directory"""
439
unique_add(self._new_reference_revision, trans_id, revision_id)
441
def version_file(self, file_id, trans_id):
442
"""Schedule a file to become versioned."""
443
assert file_id is not None
444
unique_add(self._new_id, trans_id, file_id)
445
unique_add(self._r_new_id, file_id, trans_id)
447
def cancel_versioning(self, trans_id):
448
"""Undo a previous versioning of a file"""
449
file_id = self._new_id[trans_id]
450
del self._new_id[trans_id]
451
del self._r_new_id[file_id]
454
"""Determine the paths of all new and changed files"""
456
fp = FinalPaths(self)
457
for id_set in (self._new_name, self._new_parent, self._new_contents,
458
self._new_id, self._new_executability):
459
new_ids.update(id_set)
460
new_paths = [(fp.get_path(t), t) for t in new_ids]
464
def tree_kind(self, trans_id):
465
"""Determine the file kind in the working tree.
467
Raises NoSuchFile if the file does not exist
469
path = self._tree_id_paths.get(trans_id)
471
raise NoSuchFile(None)
473
return file_kind(self._tree.abspath(path))
475
if e.errno != errno.ENOENT:
478
raise NoSuchFile(path)
480
def final_kind(self, trans_id):
481
"""Determine the final file kind, after any changes applied.
483
Raises NoSuchFile if the file does not exist/has no contents.
484
(It is conceivable that a path would be created without the
485
corresponding contents insertion command)
487
if trans_id in self._new_contents:
488
return self._new_contents[trans_id]
489
elif trans_id in self._removed_contents:
490
raise NoSuchFile(None)
492
return self.tree_kind(trans_id)
494
def tree_file_id(self, trans_id):
495
"""Determine the file id associated with the trans_id in the tree"""
497
path = self._tree_id_paths[trans_id]
499
# the file is a new, unversioned file, or invalid trans_id
501
# the file is old; the old id is still valid
502
if self._new_root == trans_id:
503
return self._tree.get_root_id()
504
return self._tree.inventory.path2id(path)
506
def final_file_id(self, trans_id):
507
"""Determine the file id after any changes are applied, or None.
509
None indicates that the file will not be versioned after changes are
513
# there is a new id for this file
514
assert self._new_id[trans_id] is not None
515
return self._new_id[trans_id]
517
if trans_id in self._removed_id:
519
return self.tree_file_id(trans_id)
521
def inactive_file_id(self, trans_id):
522
"""Return the inactive file_id associated with a transaction id.
523
That is, the one in the tree or in non_present_ids.
524
The file_id may actually be active, too.
526
file_id = self.tree_file_id(trans_id)
527
if file_id is not None:
529
for key, value in self._non_present_ids.iteritems():
530
if value == trans_id:
533
def final_parent(self, trans_id):
534
"""Determine the parent file_id, after any changes are applied.
536
ROOT_PARENT is returned for the tree root.
539
return self._new_parent[trans_id]
541
return self.get_tree_parent(trans_id)
543
def final_name(self, trans_id):
544
"""Determine the final filename, after all changes are applied."""
546
return self._new_name[trans_id]
549
return os.path.basename(self._tree_id_paths[trans_id])
551
raise NoFinalPath(trans_id, self)
554
"""Return a map of parent: children for known parents.
556
Only new paths and parents of tree files with assigned ids are used.
559
items = list(self._new_parent.iteritems())
560
items.extend((t, self.final_parent(t)) for t in
561
self._tree_id_paths.keys())
562
for trans_id, parent_id in items:
563
if parent_id not in by_parent:
564
by_parent[parent_id] = set()
565
by_parent[parent_id].add(trans_id)
568
def path_changed(self, trans_id):
569
"""Return True if a trans_id's path has changed."""
570
return (trans_id in self._new_name) or (trans_id in self._new_parent)
572
def new_contents(self, trans_id):
573
return (trans_id in self._new_contents)
575
def find_conflicts(self):
576
"""Find any violations of inventory or filesystem invariants"""
577
if self._done is True:
578
raise ReusingTransform()
580
# ensure all children of all existent parents are known
581
# all children of non-existent parents are known, by definition.
582
self._add_tree_children()
583
by_parent = self.by_parent()
584
conflicts.extend(self._unversioned_parents(by_parent))
585
conflicts.extend(self._parent_loops())
586
conflicts.extend(self._duplicate_entries(by_parent))
587
conflicts.extend(self._duplicate_ids())
588
conflicts.extend(self._parent_type_conflicts(by_parent))
589
conflicts.extend(self._improper_versioning())
590
conflicts.extend(self._executability_conflicts())
591
conflicts.extend(self._overwrite_conflicts())
594
def _add_tree_children(self):
595
"""Add all the children of all active parents to the known paths.
597
Active parents are those which gain children, and those which are
598
removed. This is a necessary first step in detecting conflicts.
600
parents = self.by_parent().keys()
601
parents.extend([t for t in self._removed_contents if
602
self.tree_kind(t) == 'directory'])
603
for trans_id in self._removed_id:
604
file_id = self.tree_file_id(trans_id)
605
if file_id is not None:
606
if self._tree.inventory[file_id].kind == 'directory':
607
parents.append(trans_id)
608
elif self.tree_kind(trans_id) == 'directory':
609
parents.append(trans_id)
611
for parent_id in parents:
612
# ensure that all children are registered with the transaction
613
list(self.iter_tree_children(parent_id))
615
def iter_tree_children(self, parent_id):
616
"""Iterate through the entry's tree children, if any"""
618
path = self._tree_id_paths[parent_id]
622
children = os.listdir(self._tree.abspath(path))
624
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
628
for child in children:
629
childpath = joinpath(path, child)
630
if self._tree.is_control_filename(childpath):
632
yield self.trans_id_tree_path(childpath)
634
def has_named_child(self, by_parent, parent_id, name):
636
children = by_parent[parent_id]
639
for child in children:
640
if self.final_name(child) == name:
643
path = self._tree_id_paths[parent_id]
646
childpath = joinpath(path, name)
647
child_id = self._tree_path_ids.get(childpath)
649
return lexists(self._tree.abspath(childpath))
651
if self.final_parent(child_id) != parent_id:
653
if child_id in self._removed_contents:
654
# XXX What about dangling file-ids?
659
def _parent_loops(self):
660
"""No entry should be its own ancestor"""
662
for trans_id in self._new_parent:
665
while parent_id is not ROOT_PARENT:
668
parent_id = self.final_parent(parent_id)
671
if parent_id == trans_id:
672
conflicts.append(('parent loop', trans_id))
673
if parent_id in seen:
677
def _unversioned_parents(self, by_parent):
678
"""If parent directories are versioned, children must be versioned."""
680
for parent_id, children in by_parent.iteritems():
681
if parent_id is ROOT_PARENT:
683
if self.final_file_id(parent_id) is not None:
685
for child_id in children:
686
if self.final_file_id(child_id) is not None:
687
conflicts.append(('unversioned parent', parent_id))
691
def _improper_versioning(self):
692
"""Cannot version a file with no contents, or a bad type.
694
However, existing entries with no contents are okay.
697
for trans_id in self._new_id.iterkeys():
699
kind = self.final_kind(trans_id)
701
conflicts.append(('versioning no contents', trans_id))
703
if not InventoryEntry.versionable_kind(kind):
704
conflicts.append(('versioning bad kind', trans_id, kind))
707
def _executability_conflicts(self):
708
"""Check for bad executability changes.
710
Only versioned files may have their executability set, because
711
1. only versioned entries can have executability under windows
712
2. only files can be executable. (The execute bit on a directory
713
does not indicate searchability)
716
for trans_id in self._new_executability:
717
if self.final_file_id(trans_id) is None:
718
conflicts.append(('unversioned executability', trans_id))
721
non_file = self.final_kind(trans_id) != "file"
725
conflicts.append(('non-file executability', trans_id))
728
def _overwrite_conflicts(self):
729
"""Check for overwrites (not permitted on Win32)"""
731
for trans_id in self._new_contents:
733
self.tree_kind(trans_id)
736
if trans_id not in self._removed_contents:
737
conflicts.append(('overwrite', trans_id,
738
self.final_name(trans_id)))
741
def _duplicate_entries(self, by_parent):
742
"""No directory may have two entries with the same name."""
744
if (self._new_name, self._new_parent) == ({}, {}):
746
for children in by_parent.itervalues():
747
name_ids = [(self.final_name(t), t) for t in children]
748
if not self._case_sensitive_target:
749
name_ids = [(n.lower(), t) for n, t in name_ids]
753
for name, trans_id in name_ids:
755
kind = self.final_kind(trans_id)
758
file_id = self.final_file_id(trans_id)
759
if kind is None and file_id is None:
761
if name == last_name:
762
conflicts.append(('duplicate', last_trans_id, trans_id,
765
last_trans_id = trans_id
768
def _duplicate_ids(self):
769
"""Each inventory id may only be used once"""
771
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
773
active_tree_ids = set((f for f in self._tree.inventory if
774
f not in removed_tree_ids))
775
for trans_id, file_id in self._new_id.iteritems():
776
if file_id in active_tree_ids:
777
old_trans_id = self.trans_id_tree_file_id(file_id)
778
conflicts.append(('duplicate id', old_trans_id, trans_id))
781
def _parent_type_conflicts(self, by_parent):
782
"""parents must have directory 'contents'."""
784
for parent_id, children in by_parent.iteritems():
785
if parent_id is ROOT_PARENT:
787
if not self._any_contents(children):
789
for child in children:
791
self.final_kind(child)
795
kind = self.final_kind(parent_id)
799
conflicts.append(('missing parent', parent_id))
800
elif kind != "directory":
801
conflicts.append(('non-directory parent', parent_id))
804
def _any_contents(self, trans_ids):
805
"""Return true if any of the trans_ids, will have contents."""
806
for trans_id in trans_ids:
808
kind = self.final_kind(trans_id)
814
def _limbo_name(self, trans_id):
815
"""Generate the limbo name of a file"""
816
limbo_name = self._limbo_files.get(trans_id)
817
if limbo_name is not None:
819
parent = self._new_parent.get(trans_id)
820
# if the parent directory is already in limbo (e.g. when building a
821
# tree), choose a limbo name inside the parent, to reduce further
823
use_direct_path = False
824
if self._new_contents.get(parent) == 'directory':
825
filename = self._new_name.get(trans_id)
826
if filename is not None:
827
if parent not in self._limbo_children:
828
self._limbo_children[parent] = set()
829
self._limbo_children_names[parent] = {}
830
use_direct_path = True
831
# the direct path can only be used if no other file has
832
# already taken this pathname, i.e. if the name is unused, or
833
# if it is already associated with this trans_id.
834
elif self._case_sensitive_target:
835
if (self._limbo_children_names[parent].get(filename)
836
in (trans_id, None)):
837
use_direct_path = True
839
for l_filename, l_trans_id in\
840
self._limbo_children_names[parent].iteritems():
841
if l_trans_id == trans_id:
843
if l_filename.lower() == filename.lower():
846
use_direct_path = True
849
limbo_name = pathjoin(self._limbo_files[parent], filename)
850
self._limbo_children[parent].add(trans_id)
851
self._limbo_children_names[parent][filename] = trans_id
853
limbo_name = pathjoin(self._limbodir, trans_id)
854
self._needs_rename.add(trans_id)
855
self._limbo_files[trans_id] = limbo_name
858
def _set_executability(self, path, entry, trans_id):
859
"""Set the executability of versioned files """
860
new_executability = self._new_executability[trans_id]
861
entry.executable = new_executability
862
if supports_executable():
863
abspath = self._tree.abspath(path)
864
current_mode = os.stat(abspath).st_mode
865
if new_executability:
868
to_mode = current_mode | (0100 & ~umask)
869
# Enable x-bit for others only if they can read it.
870
if current_mode & 0004:
871
to_mode |= 0001 & ~umask
872
if current_mode & 0040:
873
to_mode |= 0010 & ~umask
875
to_mode = current_mode & ~0111
876
os.chmod(abspath, to_mode)
878
def _new_entry(self, name, parent_id, file_id):
879
"""Helper function to create a new filesystem entry."""
880
trans_id = self.create_path(name, parent_id)
881
if file_id is not None:
882
self.version_file(file_id, trans_id)
885
def new_file(self, name, parent_id, contents, file_id=None,
887
"""Convenience method to create files.
889
name is the name of the file to create.
890
parent_id is the transaction id of the parent directory of the file.
891
contents is an iterator of bytestrings, which will be used to produce
893
:param file_id: The inventory ID of the file, if it is to be versioned.
894
:param executable: Only valid when a file_id has been supplied.
896
trans_id = self._new_entry(name, parent_id, file_id)
897
# TODO: rather than scheduling a set_executable call,
898
# have create_file create the file with the right mode.
899
self.create_file(contents, trans_id)
900
if executable is not None:
901
self.set_executability(executable, trans_id)
904
def new_directory(self, name, parent_id, file_id=None):
905
"""Convenience method to create directories.
907
name is the name of the directory to create.
908
parent_id is the transaction id of the parent directory of the
910
file_id is the inventory ID of the directory, if it is to be versioned.
912
trans_id = self._new_entry(name, parent_id, file_id)
913
self.create_directory(trans_id)
916
def new_symlink(self, name, parent_id, target, file_id=None):
917
"""Convenience method to create symbolic link.
919
name is the name of the symlink to create.
920
parent_id is the transaction id of the parent directory of the symlink.
921
target is a bytestring of the target of the symlink.
922
file_id is the inventory ID of the file, if it is to be versioned.
924
trans_id = self._new_entry(name, parent_id, file_id)
925
self.create_symlink(target, trans_id)
928
def _affected_ids(self):
929
"""Return the set of transform ids affected by the transform"""
930
trans_ids = set(self._removed_id)
931
trans_ids.update(self._new_id.keys())
932
trans_ids.update(self._removed_contents)
933
trans_ids.update(self._new_contents.keys())
934
trans_ids.update(self._new_executability.keys())
935
trans_ids.update(self._new_name.keys())
936
trans_ids.update(self._new_parent.keys())
939
def _get_file_id_maps(self):
940
"""Return mapping of file_ids to trans_ids in the to and from states"""
941
trans_ids = self._affected_ids()
944
# Build up two dicts: trans_ids associated with file ids in the
945
# FROM state, vs the TO state.
946
for trans_id in trans_ids:
947
from_file_id = self.tree_file_id(trans_id)
948
if from_file_id is not None:
949
from_trans_ids[from_file_id] = trans_id
950
to_file_id = self.final_file_id(trans_id)
951
if to_file_id is not None:
952
to_trans_ids[to_file_id] = trans_id
953
return from_trans_ids, to_trans_ids
955
def _from_file_data(self, from_trans_id, from_versioned, file_id):
956
"""Get data about a file in the from (tree) state
958
Return a (name, parent, kind, executable) tuple
960
from_path = self._tree_id_paths.get(from_trans_id)
962
# get data from working tree if versioned
963
from_entry = self._tree.inventory[file_id]
964
from_name = from_entry.name
965
from_parent = from_entry.parent_id
968
if from_path is None:
969
# File does not exist in FROM state
973
# File exists, but is not versioned. Have to use path-
975
from_name = os.path.basename(from_path)
976
tree_parent = self.get_tree_parent(from_trans_id)
977
from_parent = self.tree_file_id(tree_parent)
978
if from_path is not None:
979
from_kind, from_executable, from_stats = \
980
self._tree._comparison_data(from_entry, from_path)
983
from_executable = False
984
return from_name, from_parent, from_kind, from_executable
986
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
987
"""Get data about a file in the to (target) state
989
Return a (name, parent, kind, executable) tuple
991
to_name = self.final_name(to_trans_id)
993
to_kind = self.final_kind(to_trans_id)
996
to_parent = self.final_file_id(self.final_parent(to_trans_id))
997
if to_trans_id in self._new_executability:
998
to_executable = self._new_executability[to_trans_id]
999
elif to_trans_id == from_trans_id:
1000
to_executable = from_executable
1002
to_executable = False
1003
return to_name, to_parent, to_kind, to_executable
1005
def _iter_changes(self):
1006
"""Produce output in the same format as Tree._iter_changes.
1008
Will produce nonsensical results if invoked while inventory/filesystem
1009
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1011
This reads the Transform, but only reproduces changes involving a
1012
file_id. Files that are not versioned in either of the FROM or TO
1013
states are not reflected.
1015
final_paths = FinalPaths(self)
1016
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1018
# Now iterate through all active file_ids
1019
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1021
from_trans_id = from_trans_ids.get(file_id)
1022
# find file ids, and determine versioning state
1023
if from_trans_id is None:
1024
from_versioned = False
1025
from_trans_id = to_trans_ids[file_id]
1027
from_versioned = True
1028
to_trans_id = to_trans_ids.get(file_id)
1029
if to_trans_id is None:
1030
to_versioned = False
1031
to_trans_id = from_trans_id
1035
from_name, from_parent, from_kind, from_executable = \
1036
self._from_file_data(from_trans_id, from_versioned, file_id)
1038
to_name, to_parent, to_kind, to_executable = \
1039
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1041
if not from_versioned:
1044
from_path = self._tree_id_paths.get(from_trans_id)
1045
if not to_versioned:
1048
to_path = final_paths.get_path(to_trans_id)
1049
if from_kind != to_kind:
1051
elif to_kind in ('file', 'symlink') and (
1052
to_trans_id != from_trans_id or
1053
to_trans_id in self._new_contents):
1055
if (not modified and from_versioned == to_versioned and
1056
from_parent==to_parent and from_name == to_name and
1057
from_executable == to_executable):
1059
results.append((file_id, (from_path, to_path), modified,
1060
(from_versioned, to_versioned),
1061
(from_parent, to_parent),
1062
(from_name, to_name),
1063
(from_kind, to_kind),
1064
(from_executable, to_executable)))
1065
return iter(sorted(results, key=lambda x:x[1]))
1067
def get_preview_tree(self):
1068
"""Return a tree representing the result of the transform.
1070
This tree only supports the subset of Tree functionality required
1071
by show_diff_trees. It must only be compared to tt._tree.
1073
return _PreviewTree(self)
1076
class TreeTransform(TreeTransformBase):
1077
"""Represent a tree transformation.
1079
This object is designed to support incremental generation of the transform,
1082
However, it gives optimum performance when parent directories are created
1083
before their contents. The transform is then able to put child files
1084
directly in their parent directory, avoiding later renames.
1086
It is easy to produce malformed transforms, but they are generally
1087
harmless. Attempting to apply a malformed transform will cause an
1088
exception to be raised before any modifications are made to the tree.
1090
Many kinds of malformed transforms can be corrected with the
1091
resolve_conflicts function. The remaining ones indicate programming error,
1092
such as trying to create a file with no path.
1094
Two sets of file creation methods are supplied. Convenience methods are:
1099
These are composed of the low-level methods:
1101
* create_file or create_directory or create_symlink
1105
Transform/Transaction ids
1106
-------------------------
1107
trans_ids are temporary ids assigned to all files involved in a transform.
1108
It's possible, even common, that not all files in the Tree have trans_ids.
1110
trans_ids are used because filenames and file_ids are not good enough
1111
identifiers; filenames change, and not all files have file_ids. File-ids
1112
are also associated with trans-ids, so that moving a file moves its
1115
trans_ids are only valid for the TreeTransform that generated them.
1119
Limbo is a temporary directory use to hold new versions of files.
1120
Files are added to limbo by create_file, create_directory, create_symlink,
1121
and their convenience variants (new_*). Files may be removed from limbo
1122
using cancel_creation. Files are renamed from limbo into their final
1123
location as part of TreeTransform.apply
1125
Limbo must be cleaned up, by either calling TreeTransform.apply or
1126
calling TreeTransform.finalize.
1128
Files are placed into limbo inside their parent directories, where
1129
possible. This reduces subsequent renames, and makes operations involving
1130
lots of files faster. This optimization is only possible if the parent
1131
directory is created *before* creating any of its children, so avoid
1132
creating children before parents, where possible.
1136
This temporary directory is used by _FileMover for storing files that are
1137
about to be deleted. In case of rollback, the files will be restored.
1138
FileMover does not delete files until it is sure that a rollback will not
1141
def __init__(self, tree, pb=DummyProgress()):
1142
"""Note: a tree_write lock is taken on the tree.
1144
Use TreeTransform.finalize() to release the lock (can be omitted if
1145
TreeTransform.apply() called).
1147
tree.lock_tree_write()
1150
control_files = tree._control_files
1151
limbodir = urlutils.local_path_from_url(
1152
control_files.controlfilename('limbo'))
1156
if e.errno == errno.EEXIST:
1157
raise ExistingLimbo(limbodir)
1158
deletiondir = urlutils.local_path_from_url(
1159
control_files.controlfilename('pending-deletion'))
1161
os.mkdir(deletiondir)
1163
if e.errno == errno.EEXIST:
1164
raise errors.ExistingPendingDeletion(deletiondir)
1169
TreeTransformBase.__init__(self, tree, limbodir, pb,
1170
tree.case_sensitive)
1171
self._deletiondir = deletiondir
1173
def apply(self, no_conflicts=False, _mover=None):
1174
"""Apply all changes to the inventory and filesystem.
1176
If filesystem or inventory conflicts are present, MalformedTransform
1179
If apply succeeds, finalize is not necessary.
1181
:param no_conflicts: if True, the caller guarantees there are no
1182
conflicts, so no check is made.
1183
:param _mover: Supply an alternate FileMover, for testing
1185
if not no_conflicts:
1186
conflicts = self.find_conflicts()
1187
if len(conflicts) != 0:
1188
raise MalformedTransform(conflicts=conflicts)
1189
inv = self._tree.inventory
1190
inventory_delta = []
1191
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1194
mover = _FileMover()
1198
child_pb.update('Apply phase', 0, 2)
1199
self._apply_removals(inv, inventory_delta, mover)
1200
child_pb.update('Apply phase', 1, 2)
1201
modified_paths = self._apply_insertions(inv, inventory_delta,
1207
mover.apply_deletions()
1210
self._tree.apply_inventory_delta(inventory_delta)
1213
return _TransformResults(modified_paths, self.rename_count)
1215
def _apply_removals(self, inv, inventory_delta, mover):
1216
"""Perform tree operations that remove directory/inventory names.
1218
That is, delete files that are to be deleted, and put any files that
1219
need renaming into limbo. This must be done in strict child-to-parent
1222
tree_paths = list(self._tree_path_ids.iteritems())
1223
tree_paths.sort(reverse=True)
1224
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1226
for num, data in enumerate(tree_paths):
1227
path, trans_id = data
1228
child_pb.update('removing file', num, len(tree_paths))
1229
full_path = self._tree.abspath(path)
1230
if trans_id in self._removed_contents:
1231
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1233
elif trans_id in self._new_name or trans_id in \
1236
mover.rename(full_path, self._limbo_name(trans_id))
1238
if e.errno != errno.ENOENT:
1241
self.rename_count += 1
1242
if trans_id in self._removed_id:
1243
if trans_id == self._new_root:
1244
file_id = self._tree.get_root_id()
1246
file_id = self.tree_file_id(trans_id)
1247
if file_id is not None:
1248
inventory_delta.append((path, None, file_id, None))
1252
def _apply_insertions(self, inv, inventory_delta, mover):
1253
"""Perform tree operations that insert directory/inventory names.
1255
That is, create any files that need to be created, and restore from
1256
limbo any files that needed renaming. This must be done in strict
1257
parent-to-child order.
1259
new_paths = self.new_paths()
1261
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1264
for num, (path, trans_id) in enumerate(new_paths):
1266
child_pb.update('adding file', num, len(new_paths))
1268
kind = self._new_contents[trans_id]
1270
kind = contents = None
1271
if trans_id in self._new_contents or \
1272
self.path_changed(trans_id):
1273
full_path = self._tree.abspath(path)
1274
if trans_id in self._needs_rename:
1276
mover.rename(self._limbo_name(trans_id), full_path)
1278
# We may be renaming a dangling inventory id
1279
if e.errno != errno.ENOENT:
1282
self.rename_count += 1
1283
if trans_id in self._new_contents:
1284
modified_paths.append(full_path)
1285
completed_new.append(trans_id)
1287
if trans_id in self._new_id:
1289
kind = file_kind(self._tree.abspath(path))
1290
if trans_id in self._new_reference_revision:
1291
new_entry = inventory.TreeReference(
1292
self._new_id[trans_id],
1293
self._new_name[trans_id],
1294
self.final_file_id(self._new_parent[trans_id]),
1295
None, self._new_reference_revision[trans_id])
1297
new_entry = inventory.make_entry(kind,
1298
self.final_name(trans_id),
1299
self.final_file_id(self.final_parent(trans_id)),
1300
self._new_id[trans_id])
1302
if trans_id in self._new_name or trans_id in\
1303
self._new_parent or\
1304
trans_id in self._new_executability:
1305
file_id = self.final_file_id(trans_id)
1306
if file_id is not None:
1307
entry = inv[file_id]
1308
new_entry = entry.copy()
1310
if trans_id in self._new_name or trans_id in\
1312
if new_entry is not None:
1313
new_entry.name = self.final_name(trans_id)
1314
parent = self.final_parent(trans_id)
1315
parent_id = self.final_file_id(parent)
1316
new_entry.parent_id = parent_id
1318
if trans_id in self._new_executability:
1319
self._set_executability(path, new_entry, trans_id)
1320
if new_entry is not None:
1321
if new_entry.file_id in inv:
1322
old_path = inv.id2path(new_entry.file_id)
1325
inventory_delta.append((old_path, path,
1330
for trans_id in completed_new:
1331
del self._new_contents[trans_id]
1332
return modified_paths
1335
class TransformPreview(TreeTransformBase):
1336
"""A TreeTransform for generating preview trees.
1338
Unlike TreeTransform, this version works when the input tree is a
1339
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1340
unversioned files in the input tree.
1343
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1345
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1346
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1348
def canonical_path(self, path):
1351
def tree_kind(self, trans_id):
1352
path = self._tree_id_paths.get(trans_id)
1354
raise NoSuchFile(None)
1355
file_id = self._tree.path2id(path)
1356
return self._tree.kind(file_id)
1358
def _set_mode(self, trans_id, mode_id, typefunc):
1359
"""Set the mode of new file contents.
1360
The mode_id is the existing file to get the mode from (often the same
1361
as trans_id). The operation is only performed if there's a mode match
1362
according to typefunc.
1364
# is it ok to ignore this? probably
1367
def iter_tree_children(self, parent_id):
1368
"""Iterate through the entry's tree children, if any"""
1370
path = self._tree_id_paths[parent_id]
1373
file_id = self.tree_file_id(parent_id)
1374
for child in self._tree.inventory[file_id].children.iterkeys():
1375
childpath = joinpath(path, child)
1376
yield self.trans_id_tree_path(childpath)
1379
class _PreviewTree(object):
1380
"""Partial implementation of Tree to support show_diff_trees"""
1382
def __init__(self, transform):
1383
self._transform = transform
1385
def lock_read(self):
1386
# Perhaps in theory, this should lock the TreeTransform?
1392
def _iter_changes(self, from_tree, include_unchanged=False,
1393
specific_files=None, pb=None, extra_trees=None,
1394
require_versioned=True, want_unversioned=False):
1395
"""See InterTree._iter_changes.
1397
This implementation does not support include_unchanged, specific_files,
1398
or want_unversioned. extra_trees, require_versioned, and pb are
1401
if from_tree is not self._transform._tree:
1402
raise ValueError('from_tree must be transform source tree.')
1403
if include_unchanged:
1404
raise ValueError('include_unchanged is not supported')
1405
if specific_files is not None:
1406
raise ValueError('specific_files is not supported')
1407
if want_unversioned:
1408
raise ValueError('want_unversioned is not supported')
1409
return self._transform._iter_changes()
1411
def kind(self, file_id):
1412
trans_id = self._transform.trans_id_file_id(file_id)
1413
return self._transform.final_kind(trans_id)
1415
def get_file_mtime(self, file_id, path=None):
1416
"""See Tree.get_file_mtime"""
1417
trans_id = self._transform.trans_id_file_id(file_id)
1418
name = self._transform._limbo_name(trans_id)
1419
return os.stat(name).st_mtime
1421
def get_file(self, file_id):
1422
"""See Tree.get_file"""
1423
trans_id = self._transform.trans_id_file_id(file_id)
1424
name = self._transform._limbo_name(trans_id)
1425
return open(name, 'rb')
1427
def get_symlink_target(self, file_id):
1428
"""See Tree.get_symlink_target"""
1429
trans_id = self._transform.trans_id_file_id(file_id)
1430
name = self._transform._limbo_name(trans_id)
1431
return os.readlink(name)
1433
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1434
"""See Tree.paths2ids"""
1438
def joinpath(parent, child):
1439
"""Join tree-relative paths, handling the tree root specially"""
1440
if parent is None or parent == "":
1443
return pathjoin(parent, child)
1446
class FinalPaths(object):
1447
"""Make path calculation cheap by memoizing paths.
1449
The underlying tree must not be manipulated between calls, or else
1450
the results will likely be incorrect.
1452
def __init__(self, transform):
1453
object.__init__(self)
1454
self._known_paths = {}
1455
self.transform = transform
1457
def _determine_path(self, trans_id):
1458
if trans_id == self.transform.root:
1460
name = self.transform.final_name(trans_id)
1461
parent_id = self.transform.final_parent(trans_id)
1462
if parent_id == self.transform.root:
1465
return pathjoin(self.get_path(parent_id), name)
1467
def get_path(self, trans_id):
1468
"""Find the final path associated with a trans_id"""
1469
if trans_id not in self._known_paths:
1470
self._known_paths[trans_id] = self._determine_path(trans_id)
1471
return self._known_paths[trans_id]
1474
def topology_sorted_ids(tree):
1475
"""Determine the topological order of the ids in a tree"""
1476
file_ids = list(tree)
1477
file_ids.sort(key=tree.id2path)
1481
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
1482
"""Create working tree for a branch, using a TreeTransform.
1484
This function should be used on empty trees, having a tree root at most.
1485
(see merge and revert functionality for working with existing trees)
1487
Existing files are handled like so:
1489
- Existing bzrdirs take precedence over creating new items. They are
1490
created as '%s.diverted' % name.
1491
- Otherwise, if the content on disk matches the content we are building,
1492
it is silently replaced.
1493
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1495
:param tree: The tree to convert wt into a copy of
1496
:param wt: The working tree that files will be placed into
1497
:param accelerator_tree: A tree which can be used for retrieving file
1498
contents more quickly than tree itself, i.e. a workingtree. tree
1499
will be used for cases where accelerator_tree's content is different.
1500
:param hardlink: If true, hard-link files to accelerator_tree, where
1501
possible. accelerator_tree must implement abspath, i.e. be a
1504
wt.lock_tree_write()
1508
if accelerator_tree is not None:
1509
accelerator_tree.lock_read()
1511
return _build_tree(tree, wt, accelerator_tree, hardlink)
1513
if accelerator_tree is not None:
1514
accelerator_tree.unlock()
1521
def _build_tree(tree, wt, accelerator_tree, hardlink):
1522
"""See build_tree."""
1523
if len(wt.inventory) > 1: # more than just a root
1524
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1526
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1527
pp = ProgressPhase("Build phase", 2, top_pb)
1528
if tree.inventory.root is not None:
1529
# This is kind of a hack: we should be altering the root
1530
# as part of the regular tree shape diff logic.
1531
# The conditional test here is to avoid doing an
1532
# expensive operation (flush) every time the root id
1533
# is set within the tree, nor setting the root and thus
1534
# marking the tree as dirty, because we use two different
1535
# idioms here: tree interfaces and inventory interfaces.
1536
if wt.get_root_id() != tree.get_root_id():
1537
wt.set_root_id(tree.get_root_id())
1539
tt = TreeTransform(wt)
1543
file_trans_id[wt.get_root_id()] = \
1544
tt.trans_id_tree_file_id(wt.get_root_id())
1545
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1547
deferred_contents = []
1549
for num, (tree_path, entry) in \
1550
enumerate(tree.inventory.iter_entries_by_dir()):
1551
pb.update("Building tree", num - len(deferred_contents),
1552
len(tree.inventory))
1553
if entry.parent_id is None:
1556
file_id = entry.file_id
1557
target_path = wt.abspath(tree_path)
1559
kind = file_kind(target_path)
1563
if kind == "directory":
1565
bzrdir.BzrDir.open(target_path)
1566
except errors.NotBranchError:
1570
if (file_id not in divert and
1571
_content_match(tree, entry, file_id, kind,
1573
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1574
if kind == 'directory':
1576
if entry.parent_id not in file_trans_id:
1577
raise AssertionError(
1578
'entry %s parent id %r is not in file_trans_id %r'
1579
% (entry, entry.parent_id, file_trans_id))
1580
parent_id = file_trans_id[entry.parent_id]
1581
if entry.kind == 'file':
1582
# We *almost* replicate new_by_entry, so that we can defer
1583
# getting the file text, and get them all at once.
1584
trans_id = tt.create_path(entry.name, parent_id)
1585
file_trans_id[file_id] = trans_id
1586
tt.version_file(entry.file_id, trans_id)
1587
executable = tree.is_executable(entry.file_id, tree_path)
1588
if executable is not None:
1589
tt.set_executability(executable, trans_id)
1590
deferred_contents.append((entry.file_id, trans_id))
1592
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1595
new_trans_id = file_trans_id[file_id]
1596
old_parent = tt.trans_id_tree_path(tree_path)
1597
_reparent_children(tt, old_parent, new_trans_id)
1598
offset = num + 1 - len(deferred_contents)
1599
_create_files(tt, tree, deferred_contents, pb, offset,
1600
accelerator_tree, hardlink)
1604
divert_trans = set(file_trans_id[f] for f in divert)
1605
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1606
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1607
conflicts = cook_conflicts(raw_conflicts, tt)
1608
for conflict in conflicts:
1611
wt.add_conflicts(conflicts)
1612
except errors.UnsupportedOperation:
1614
result = tt.apply(no_conflicts=True)
1621
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1623
total = len(desired_files) + offset
1624
if accelerator_tree is None:
1625
new_desired_files = desired_files
1627
iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
1628
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1629
in iter if not (c or e[0] != e[1]))
1630
new_desired_files = []
1632
for file_id, trans_id in desired_files:
1633
accelerator_path = unchanged.get(file_id)
1634
if accelerator_path is None:
1635
new_desired_files.append((file_id, trans_id))
1637
pb.update('Adding file contents', count + offset, total)
1639
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1642
contents = accelerator_tree.get_file(file_id, accelerator_path)
1644
tt.create_file(contents, trans_id)
1649
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1650
new_desired_files)):
1651
tt.create_file(contents, trans_id)
1652
pb.update('Adding file contents', count + offset, total)
1655
def _reparent_children(tt, old_parent, new_parent):
1656
for child in tt.iter_tree_children(old_parent):
1657
tt.adjust_path(tt.final_name(child), new_parent, child)
1659
def _reparent_transform_children(tt, old_parent, new_parent):
1660
by_parent = tt.by_parent()
1661
for child in by_parent[old_parent]:
1662
tt.adjust_path(tt.final_name(child), new_parent, child)
1664
def _content_match(tree, entry, file_id, kind, target_path):
1665
if entry.kind != kind:
1667
if entry.kind == "directory":
1669
if entry.kind == "file":
1670
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1672
elif entry.kind == "symlink":
1673
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1678
def resolve_checkout(tt, conflicts, divert):
1679
new_conflicts = set()
1680
for c_type, conflict in ((c[0], c) for c in conflicts):
1681
# Anything but a 'duplicate' would indicate programmer error
1682
assert c_type == 'duplicate', c_type
1683
# Now figure out which is new and which is old
1684
if tt.new_contents(conflict[1]):
1685
new_file = conflict[1]
1686
old_file = conflict[2]
1688
new_file = conflict[2]
1689
old_file = conflict[1]
1691
# We should only get here if the conflict wasn't completely
1693
final_parent = tt.final_parent(old_file)
1694
if new_file in divert:
1695
new_name = tt.final_name(old_file)+'.diverted'
1696
tt.adjust_path(new_name, final_parent, new_file)
1697
new_conflicts.add((c_type, 'Diverted to',
1698
new_file, old_file))
1700
new_name = tt.final_name(old_file)+'.moved'
1701
tt.adjust_path(new_name, final_parent, old_file)
1702
new_conflicts.add((c_type, 'Moved existing file to',
1703
old_file, new_file))
1704
return new_conflicts
1707
def new_by_entry(tt, entry, parent_id, tree):
1708
"""Create a new file according to its inventory entry"""
1712
contents = tree.get_file(entry.file_id).readlines()
1713
executable = tree.is_executable(entry.file_id)
1714
return tt.new_file(name, parent_id, contents, entry.file_id,
1716
elif kind in ('directory', 'tree-reference'):
1717
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1718
if kind == 'tree-reference':
1719
tt.set_tree_reference(entry.reference_revision, trans_id)
1721
elif kind == 'symlink':
1722
target = tree.get_symlink_target(entry.file_id)
1723
return tt.new_symlink(name, parent_id, target, entry.file_id)
1725
raise errors.BadFileKindError(name, kind)
1728
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1729
"""Create new file contents according to an inventory entry."""
1730
if entry.kind == "file":
1732
lines = tree.get_file(entry.file_id).readlines()
1733
tt.create_file(lines, trans_id, mode_id=mode_id)
1734
elif entry.kind == "symlink":
1735
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1736
elif entry.kind == "directory":
1737
tt.create_directory(trans_id)
1740
def create_entry_executability(tt, entry, trans_id):
1741
"""Set the executability of a trans_id according to an inventory entry"""
1742
if entry.kind == "file":
1743
tt.set_executability(entry.executable, trans_id)
1746
@deprecated_function(zero_fifteen)
1747
def find_interesting(working_tree, target_tree, filenames):
1748
"""Find the ids corresponding to specified filenames.
1750
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1752
working_tree.lock_read()
1754
target_tree.lock_read()
1756
return working_tree.paths2ids(filenames, [target_tree])
1758
target_tree.unlock()
1760
working_tree.unlock()
1763
@deprecated_function(zero_ninety)
1764
def change_entry(tt, file_id, working_tree, target_tree,
1765
trans_id_file_id, backups, trans_id, by_parent):
1766
"""Replace a file_id's contents with those from a target tree."""
1767
if file_id is None and target_tree is None:
1768
# skip the logic altogether in the deprecation test
1770
e_trans_id = trans_id_file_id(file_id)
1771
entry = target_tree.inventory[file_id]
1772
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1775
mode_id = e_trans_id
1778
tt.delete_contents(e_trans_id)
1780
parent_trans_id = trans_id_file_id(entry.parent_id)
1781
backup_name = get_backup_name(entry, by_parent,
1782
parent_trans_id, tt)
1783
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1784
tt.unversion_file(e_trans_id)
1785
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1786
tt.version_file(file_id, e_trans_id)
1787
trans_id[file_id] = e_trans_id
1788
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1789
create_entry_executability(tt, entry, e_trans_id)
1792
tt.set_executability(entry.executable, e_trans_id)
1793
if tt.final_name(e_trans_id) != entry.name:
1796
parent_id = tt.final_parent(e_trans_id)
1797
parent_file_id = tt.final_file_id(parent_id)
1798
if parent_file_id != entry.parent_id:
1803
parent_trans_id = trans_id_file_id(entry.parent_id)
1804
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1807
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1808
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1811
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1812
"""Produce a backup-style name that appears to be available"""
1816
yield "%s.~%d~" % (name, counter)
1818
for new_name in name_gen():
1819
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1823
def _entry_changes(file_id, entry, working_tree):
1824
"""Determine in which ways the inventory entry has changed.
1826
Returns booleans: has_contents, content_mod, meta_mod
1827
has_contents means there are currently contents, but they differ
1828
contents_mod means contents need to be modified
1829
meta_mod means the metadata needs to be modified
1831
cur_entry = working_tree.inventory[file_id]
1833
working_kind = working_tree.kind(file_id)
1836
has_contents = False
1839
if has_contents is True:
1840
if entry.kind != working_kind:
1841
contents_mod, meta_mod = True, False
1843
cur_entry._read_tree_state(working_tree.id2path(file_id),
1845
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1846
cur_entry._forget_tree_state()
1847
return has_contents, contents_mod, meta_mod
1850
def revert(working_tree, target_tree, filenames, backups=False,
1851
pb=DummyProgress(), change_reporter=None):
1852
"""Revert a working tree's contents to those of a target tree."""
1853
target_tree.lock_read()
1854
tt = TreeTransform(working_tree, pb)
1856
pp = ProgressPhase("Revert phase", 3, pb)
1858
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1860
merge_modified = _alter_files(working_tree, target_tree, tt,
1861
child_pb, filenames, backups)
1865
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1867
raw_conflicts = resolve_conflicts(tt, child_pb,
1868
lambda t, c: conflict_pass(t, c, target_tree))
1871
conflicts = cook_conflicts(raw_conflicts, tt)
1873
change_reporter = delta._ChangeReporter(
1874
unversioned_filter=working_tree.is_ignored)
1875
delta.report_changes(tt._iter_changes(), change_reporter)
1876
for conflict in conflicts:
1880
working_tree.set_merge_modified(merge_modified)
1882
target_tree.unlock()
1888
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1890
merge_modified = working_tree.merge_modified()
1891
change_list = target_tree._iter_changes(working_tree,
1892
specific_files=specific_files, pb=pb)
1893
if target_tree.inventory.root is None:
1900
for id_num, (file_id, path, changed_content, versioned, parent, name,
1901
kind, executable) in enumerate(change_list):
1902
if skip_root and file_id[0] is not None and parent[0] is None:
1904
trans_id = tt.trans_id_file_id(file_id)
1907
keep_content = False
1908
if kind[0] == 'file' and (backups or kind[1] is None):
1909
wt_sha1 = working_tree.get_file_sha1(file_id)
1910
if merge_modified.get(file_id) != wt_sha1:
1911
# acquire the basis tree lazily to prevent the
1912
# expense of accessing it when it's not needed ?
1913
# (Guessing, RBC, 200702)
1914
if basis_tree is None:
1915
basis_tree = working_tree.basis_tree()
1916
basis_tree.lock_read()
1917
if file_id in basis_tree:
1918
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1920
elif kind[1] is None and not versioned[1]:
1922
if kind[0] is not None:
1923
if not keep_content:
1924
tt.delete_contents(trans_id)
1925
elif kind[1] is not None:
1926
parent_trans_id = tt.trans_id_file_id(parent[0])
1927
by_parent = tt.by_parent()
1928
backup_name = _get_backup_name(name[0], by_parent,
1929
parent_trans_id, tt)
1930
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1931
new_trans_id = tt.create_path(name[0], parent_trans_id)
1932
if versioned == (True, True):
1933
tt.unversion_file(trans_id)
1934
tt.version_file(file_id, new_trans_id)
1935
# New contents should have the same unix perms as old
1938
trans_id = new_trans_id
1939
if kind[1] == 'directory':
1940
tt.create_directory(trans_id)
1941
elif kind[1] == 'symlink':
1942
tt.create_symlink(target_tree.get_symlink_target(file_id),
1944
elif kind[1] == 'file':
1945
deferred_files.append((file_id, (trans_id, mode_id)))
1946
if basis_tree is None:
1947
basis_tree = working_tree.basis_tree()
1948
basis_tree.lock_read()
1949
new_sha1 = target_tree.get_file_sha1(file_id)
1950
if (file_id in basis_tree and new_sha1 ==
1951
basis_tree.get_file_sha1(file_id)):
1952
if file_id in merge_modified:
1953
del merge_modified[file_id]
1955
merge_modified[file_id] = new_sha1
1957
# preserve the execute bit when backing up
1958
if keep_content and executable[0] == executable[1]:
1959
tt.set_executability(executable[1], trans_id)
1961
assert kind[1] is None
1962
if versioned == (False, True):
1963
tt.version_file(file_id, trans_id)
1964
if versioned == (True, False):
1965
tt.unversion_file(trans_id)
1966
if (name[1] is not None and
1967
(name[0] != name[1] or parent[0] != parent[1])):
1969
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1970
if executable[0] != executable[1] and kind[1] == "file":
1971
tt.set_executability(executable[1], trans_id)
1972
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1974
tt.create_file(bytes, trans_id, mode_id)
1976
if basis_tree is not None:
1978
return merge_modified
1981
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1982
"""Make many conflict-resolution attempts, but die if they fail"""
1983
if pass_func is None:
1984
pass_func = conflict_pass
1985
new_conflicts = set()
1988
pb.update('Resolution pass', n+1, 10)
1989
conflicts = tt.find_conflicts()
1990
if len(conflicts) == 0:
1991
return new_conflicts
1992
new_conflicts.update(pass_func(tt, conflicts))
1993
raise MalformedTransform(conflicts=conflicts)
1998
def conflict_pass(tt, conflicts, path_tree=None):
1999
"""Resolve some classes of conflicts.
2001
:param tt: The transform to resolve conflicts in
2002
:param conflicts: The conflicts to resolve
2003
:param path_tree: A Tree to get supplemental paths from
2005
new_conflicts = set()
2006
for c_type, conflict in ((c[0], c) for c in conflicts):
2007
if c_type == 'duplicate id':
2008
tt.unversion_file(conflict[1])
2009
new_conflicts.add((c_type, 'Unversioned existing file',
2010
conflict[1], conflict[2], ))
2011
elif c_type == 'duplicate':
2012
# files that were renamed take precedence
2013
final_parent = tt.final_parent(conflict[1])
2014
if tt.path_changed(conflict[1]):
2015
existing_file, new_file = conflict[2], conflict[1]
2017
existing_file, new_file = conflict[1], conflict[2]
2018
new_name = tt.final_name(existing_file)+'.moved'
2019
tt.adjust_path(new_name, final_parent, existing_file)
2020
new_conflicts.add((c_type, 'Moved existing file to',
2021
existing_file, new_file))
2022
elif c_type == 'parent loop':
2023
# break the loop by undoing one of the ops that caused the loop
2025
while not tt.path_changed(cur):
2026
cur = tt.final_parent(cur)
2027
new_conflicts.add((c_type, 'Cancelled move', cur,
2028
tt.final_parent(cur),))
2029
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2031
elif c_type == 'missing parent':
2032
trans_id = conflict[1]
2034
tt.cancel_deletion(trans_id)
2035
new_conflicts.add(('deleting parent', 'Not deleting',
2038
tt.create_directory(trans_id)
2039
new_conflicts.add((c_type, 'Created directory', trans_id))
2041
tt.final_name(trans_id)
2043
if path_tree is not None:
2044
file_id = tt.final_file_id(trans_id)
2045
entry = path_tree.inventory[file_id]
2046
parent_trans_id = tt.trans_id_file_id(entry.parent_id)
2047
tt.adjust_path(entry.name, parent_trans_id, trans_id)
2048
elif c_type == 'unversioned parent':
2049
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
2050
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2051
elif c_type == 'non-directory parent':
2052
parent_id = conflict[1]
2053
parent_parent = tt.final_parent(parent_id)
2054
parent_name = tt.final_name(parent_id)
2055
parent_file_id = tt.final_file_id(parent_id)
2056
new_parent_id = tt.new_directory(parent_name + '.new',
2057
parent_parent, parent_file_id)
2058
_reparent_transform_children(tt, parent_id, new_parent_id)
2059
tt.unversion_file(parent_id)
2060
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2061
return new_conflicts
2064
def cook_conflicts(raw_conflicts, tt):
2065
"""Generate a list of cooked conflicts, sorted by file path"""
2066
from bzrlib.conflicts import Conflict
2067
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2068
return sorted(conflict_iter, key=Conflict.sort_key)
2071
def iter_cook_conflicts(raw_conflicts, tt):
2072
from bzrlib.conflicts import Conflict
2074
for conflict in raw_conflicts:
2075
c_type = conflict[0]
2076
action = conflict[1]
2077
modified_path = fp.get_path(conflict[2])
2078
modified_id = tt.final_file_id(conflict[2])
2079
if len(conflict) == 3:
2080
yield Conflict.factory(c_type, action=action, path=modified_path,
2081
file_id=modified_id)
2084
conflicting_path = fp.get_path(conflict[3])
2085
conflicting_id = tt.final_file_id(conflict[3])
2086
yield Conflict.factory(c_type, action=action, path=modified_path,
2087
file_id=modified_id,
2088
conflict_path=conflicting_path,
2089
conflict_file_id=conflicting_id)
2092
class _FileMover(object):
2093
"""Moves and deletes files for TreeTransform, tracking operations"""
2096
self.past_renames = []
2097
self.pending_deletions = []
2099
def rename(self, from_, to):
2100
"""Rename a file from one path to another. Functions like os.rename"""
2102
os.rename(from_, to)
2104
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2105
raise errors.FileExists(to, str(e))
2107
self.past_renames.append((from_, to))
2109
def pre_delete(self, from_, to):
2110
"""Rename a file out of the way and mark it for deletion.
2112
Unlike os.unlink, this works equally well for files and directories.
2113
:param from_: The current file path
2114
:param to: A temporary path for the file
2116
self.rename(from_, to)
2117
self.pending_deletions.append(to)
2120
"""Reverse all renames that have been performed"""
2121
for from_, to in reversed(self.past_renames):
2122
os.rename(to, from_)
2123
# after rollback, don't reuse _FileMover
2125
pending_deletions = None
2127
def apply_deletions(self):
2128
"""Apply all marked deletions"""
2129
for path in self.pending_deletions:
2131
# after apply_deletions, don't reuse _FileMover
2133
pending_deletions = None
added
removed
bzrlib/transform.py
