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(), """
29
revision as _mod_revision,
32
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
33
ReusingTransform, NotVersionedError, CantMoveRoot,
34
ExistingLimbo, ImmortalLimbo, NoFinalPath,
36
from bzrlib.inventory import InventoryEntry
37
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
38
delete_any, has_symlinks)
39
from bzrlib.progress import DummyProgress, ProgressPhase
40
from bzrlib.symbol_versioning import (
43
from bzrlib.trace import mutter, warning
44
from bzrlib import tree
46
import bzrlib.urlutils as urlutils
49
ROOT_PARENT = "root-parent"
52
def unique_add(map, key, value):
54
raise DuplicateKey(key=key)
58
class _TransformResults(object):
59
def __init__(self, modified_paths, rename_count):
61
self.modified_paths = modified_paths
62
self.rename_count = rename_count
65
class TreeTransformBase(object):
66
"""The base class for TreeTransform and TreeTransformBase"""
68
def __init__(self, tree, limbodir, pb=DummyProgress(),
72
:param tree: The tree that will be transformed, but not necessarily
74
:param limbodir: A directory where new files can be stored until
75
they are installed in their proper places
76
:param pb: A ProgressBar indicating how much progress is being made
77
:param case_sensitive: If True, the target of the transform is
78
case sensitive, not just case preserving.
82
self._limbodir = limbodir
83
self._deletiondir = None
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
if self._deletiondir is not None:
162
os.rmdir(self._deletiondir)
164
raise errors.ImmortalPendingDeletion(self._deletiondir)
169
def _assign_id(self):
170
"""Produce a new tranform id"""
171
new_id = "new-%s" % self._id_number
175
def create_path(self, name, parent):
176
"""Assign a transaction id to a new path"""
177
trans_id = self._assign_id()
178
unique_add(self._new_name, trans_id, name)
179
unique_add(self._new_parent, trans_id, parent)
182
def adjust_path(self, name, parent, trans_id):
183
"""Change the path that is assigned to a transaction id."""
184
if trans_id == self._new_root:
186
previous_parent = self._new_parent.get(trans_id)
187
previous_name = self._new_name.get(trans_id)
188
self._new_name[trans_id] = name
189
self._new_parent[trans_id] = parent
190
if (trans_id in self._limbo_files and
191
trans_id not in self._needs_rename):
192
self._rename_in_limbo([trans_id])
193
self._limbo_children[previous_parent].remove(trans_id)
194
del self._limbo_children_names[previous_parent][previous_name]
196
def _rename_in_limbo(self, trans_ids):
197
"""Fix limbo names so that the right final path is produced.
199
This means we outsmarted ourselves-- we tried to avoid renaming
200
these files later by creating them with their final names in their
201
final parents. But now the previous name or parent is no longer
202
suitable, so we have to rename them.
204
Even for trans_ids that have no new contents, we must remove their
205
entries from _limbo_files, because they are now stale.
207
for trans_id in trans_ids:
208
old_path = self._limbo_files.pop(trans_id)
209
if trans_id not in self._new_contents:
211
new_path = self._limbo_name(trans_id)
212
os.rename(old_path, new_path)
214
def adjust_root_path(self, name, parent):
215
"""Emulate moving the root by moving all children, instead.
217
We do this by undoing the association of root's transaction id with the
218
current tree. This allows us to create a new directory with that
219
transaction id. We unversion the root directory and version the
220
physically new directory, and hope someone versions the tree root
223
old_root = self._new_root
224
old_root_file_id = self.final_file_id(old_root)
225
# force moving all children of root
226
for child_id in self.iter_tree_children(old_root):
227
if child_id != parent:
228
self.adjust_path(self.final_name(child_id),
229
self.final_parent(child_id), child_id)
230
file_id = self.final_file_id(child_id)
231
if file_id is not None:
232
self.unversion_file(child_id)
233
self.version_file(file_id, child_id)
235
# the physical root needs a new transaction id
236
self._tree_path_ids.pop("")
237
self._tree_id_paths.pop(old_root)
238
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
239
if parent == old_root:
240
parent = self._new_root
241
self.adjust_path(name, parent, old_root)
242
self.create_directory(old_root)
243
self.version_file(old_root_file_id, old_root)
244
self.unversion_file(self._new_root)
246
def trans_id_tree_file_id(self, inventory_id):
247
"""Determine the transaction id of a working tree file.
249
This reflects only files that already exist, not ones that will be
250
added by transactions.
252
path = self._tree.id2path(inventory_id)
253
return self.trans_id_tree_path(path)
255
def trans_id_file_id(self, file_id):
256
"""Determine or set the transaction id associated with a file ID.
257
A new id is only created for file_ids that were never present. If
258
a transaction has been unversioned, it is deliberately still returned.
259
(this will likely lead to an unversioned parent conflict.)
261
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
262
return self._r_new_id[file_id]
263
elif file_id in self._tree.inventory:
264
return self.trans_id_tree_file_id(file_id)
265
elif file_id in self._non_present_ids:
266
return self._non_present_ids[file_id]
268
trans_id = self._assign_id()
269
self._non_present_ids[file_id] = trans_id
272
def canonical_path(self, path):
273
"""Get the canonical tree-relative path"""
274
# don't follow final symlinks
275
abs = self._tree.abspath(path)
276
if abs in self._relpaths:
277
return self._relpaths[abs]
278
dirname, basename = os.path.split(abs)
279
if dirname not in self._realpaths:
280
self._realpaths[dirname] = os.path.realpath(dirname)
281
dirname = self._realpaths[dirname]
282
abs = pathjoin(dirname, basename)
283
if dirname in self._relpaths:
284
relpath = pathjoin(self._relpaths[dirname], basename)
285
relpath = relpath.rstrip('/\\')
287
relpath = self._tree.relpath(abs)
288
self._relpaths[abs] = relpath
291
def trans_id_tree_path(self, path):
292
"""Determine (and maybe set) the transaction ID for a tree path."""
293
path = self.canonical_path(path)
294
if path not in self._tree_path_ids:
295
self._tree_path_ids[path] = self._assign_id()
296
self._tree_id_paths[self._tree_path_ids[path]] = path
297
return self._tree_path_ids[path]
299
def get_tree_parent(self, trans_id):
300
"""Determine id of the parent in the tree."""
301
path = self._tree_id_paths[trans_id]
304
return self.trans_id_tree_path(os.path.dirname(path))
306
def create_file(self, contents, trans_id, mode_id=None):
307
"""Schedule creation of a new file.
311
Contents is an iterator of strings, all of which will be written
312
to the target destination.
314
New file takes the permissions of any existing file with that id,
315
unless mode_id is specified.
317
name = self._limbo_name(trans_id)
321
unique_add(self._new_contents, trans_id, 'file')
323
# Clean up the file, it never got registered so
324
# TreeTransform.finalize() won't clean it up.
329
f.writelines(contents)
332
self._set_mode(trans_id, mode_id, S_ISREG)
334
def _set_mode(self, trans_id, mode_id, typefunc):
335
"""Set the mode of new file contents.
336
The mode_id is the existing file to get the mode from (often the same
337
as trans_id). The operation is only performed if there's a mode match
338
according to typefunc.
343
old_path = self._tree_id_paths[mode_id]
347
mode = os.stat(self._tree.abspath(old_path)).st_mode
349
if e.errno == errno.ENOENT:
354
os.chmod(self._limbo_name(trans_id), mode)
356
def create_hardlink(self, path, trans_id):
357
"""Schedule creation of a hard link"""
358
name = self._limbo_name(trans_id)
362
if e.errno != errno.EPERM:
364
raise errors.HardLinkNotSupported(path)
366
unique_add(self._new_contents, trans_id, 'file')
368
# Clean up the file, it never got registered so
369
# TreeTransform.finalize() won't clean it up.
373
def create_directory(self, trans_id):
374
"""Schedule creation of a new directory.
376
See also new_directory.
378
os.mkdir(self._limbo_name(trans_id))
379
unique_add(self._new_contents, trans_id, 'directory')
381
def create_symlink(self, target, trans_id):
382
"""Schedule creation of a new symbolic link.
384
target is a bytestring.
385
See also new_symlink.
388
os.symlink(target, self._limbo_name(trans_id))
389
unique_add(self._new_contents, trans_id, 'symlink')
392
path = FinalPaths(self).get_path(trans_id)
395
raise UnableCreateSymlink(path=path)
397
def cancel_creation(self, trans_id):
398
"""Cancel the creation of new file contents."""
399
del self._new_contents[trans_id]
400
children = self._limbo_children.get(trans_id)
401
# if this is a limbo directory with children, move them before removing
403
if children is not None:
404
self._rename_in_limbo(children)
405
del self._limbo_children[trans_id]
406
del self._limbo_children_names[trans_id]
407
delete_any(self._limbo_name(trans_id))
409
def delete_contents(self, trans_id):
410
"""Schedule the contents of a path entry for deletion"""
411
self.tree_kind(trans_id)
412
self._removed_contents.add(trans_id)
414
def cancel_deletion(self, trans_id):
415
"""Cancel a scheduled deletion"""
416
self._removed_contents.remove(trans_id)
418
def unversion_file(self, trans_id):
419
"""Schedule a path entry to become unversioned"""
420
self._removed_id.add(trans_id)
422
def delete_versioned(self, trans_id):
423
"""Delete and unversion a versioned file"""
424
self.delete_contents(trans_id)
425
self.unversion_file(trans_id)
427
def set_executability(self, executability, trans_id):
428
"""Schedule setting of the 'execute' bit
429
To unschedule, set to None
431
if executability is None:
432
del self._new_executability[trans_id]
434
unique_add(self._new_executability, trans_id, executability)
436
def set_tree_reference(self, revision_id, trans_id):
437
"""Set the reference associated with a directory"""
438
unique_add(self._new_reference_revision, trans_id, revision_id)
440
def version_file(self, file_id, trans_id):
441
"""Schedule a file to become versioned."""
442
assert file_id is not None
443
unique_add(self._new_id, trans_id, file_id)
444
unique_add(self._r_new_id, file_id, trans_id)
446
def cancel_versioning(self, trans_id):
447
"""Undo a previous versioning of a file"""
448
file_id = self._new_id[trans_id]
449
del self._new_id[trans_id]
450
del self._r_new_id[file_id]
453
"""Determine the paths of all new and changed files"""
455
fp = FinalPaths(self)
456
for id_set in (self._new_name, self._new_parent, self._new_contents,
457
self._new_id, self._new_executability):
458
new_ids.update(id_set)
459
new_paths = [(fp.get_path(t), t) for t in new_ids]
463
def tree_kind(self, trans_id):
464
"""Determine the file kind in the working tree.
466
Raises NoSuchFile if the file does not exist
468
path = self._tree_id_paths.get(trans_id)
470
raise NoSuchFile(None)
472
return file_kind(self._tree.abspath(path))
474
if e.errno != errno.ENOENT:
477
raise NoSuchFile(path)
479
def final_kind(self, trans_id):
480
"""Determine the final file kind, after any changes applied.
482
Raises NoSuchFile if the file does not exist/has no contents.
483
(It is conceivable that a path would be created without the
484
corresponding contents insertion command)
486
if trans_id in self._new_contents:
487
return self._new_contents[trans_id]
488
elif trans_id in self._removed_contents:
489
raise NoSuchFile(None)
491
return self.tree_kind(trans_id)
493
def tree_file_id(self, trans_id):
494
"""Determine the file id associated with the trans_id in the tree"""
496
path = self._tree_id_paths[trans_id]
498
# the file is a new, unversioned file, or invalid trans_id
500
# the file is old; the old id is still valid
501
if self._new_root == trans_id:
502
return self._tree.get_root_id()
503
return self._tree.inventory.path2id(path)
505
def final_file_id(self, trans_id):
506
"""Determine the file id after any changes are applied, or None.
508
None indicates that the file will not be versioned after changes are
512
# there is a new id for this file
513
assert self._new_id[trans_id] is not None
514
return self._new_id[trans_id]
516
if trans_id in self._removed_id:
518
return self.tree_file_id(trans_id)
520
def inactive_file_id(self, trans_id):
521
"""Return the inactive file_id associated with a transaction id.
522
That is, the one in the tree or in non_present_ids.
523
The file_id may actually be active, too.
525
file_id = self.tree_file_id(trans_id)
526
if file_id is not None:
528
for key, value in self._non_present_ids.iteritems():
529
if value == trans_id:
532
def final_parent(self, trans_id):
533
"""Determine the parent file_id, after any changes are applied.
535
ROOT_PARENT is returned for the tree root.
538
return self._new_parent[trans_id]
540
return self.get_tree_parent(trans_id)
542
def final_name(self, trans_id):
543
"""Determine the final filename, after all changes are applied."""
545
return self._new_name[trans_id]
548
return os.path.basename(self._tree_id_paths[trans_id])
550
raise NoFinalPath(trans_id, self)
553
"""Return a map of parent: children for known parents.
555
Only new paths and parents of tree files with assigned ids are used.
558
items = list(self._new_parent.iteritems())
559
items.extend((t, self.final_parent(t)) for t in
560
self._tree_id_paths.keys())
561
for trans_id, parent_id in items:
562
if parent_id not in by_parent:
563
by_parent[parent_id] = set()
564
by_parent[parent_id].add(trans_id)
567
def path_changed(self, trans_id):
568
"""Return True if a trans_id's path has changed."""
569
return (trans_id in self._new_name) or (trans_id in self._new_parent)
571
def new_contents(self, trans_id):
572
return (trans_id in self._new_contents)
574
def find_conflicts(self):
575
"""Find any violations of inventory or filesystem invariants"""
576
if self._done is True:
577
raise ReusingTransform()
579
# ensure all children of all existent parents are known
580
# all children of non-existent parents are known, by definition.
581
self._add_tree_children()
582
by_parent = self.by_parent()
583
conflicts.extend(self._unversioned_parents(by_parent))
584
conflicts.extend(self._parent_loops())
585
conflicts.extend(self._duplicate_entries(by_parent))
586
conflicts.extend(self._duplicate_ids())
587
conflicts.extend(self._parent_type_conflicts(by_parent))
588
conflicts.extend(self._improper_versioning())
589
conflicts.extend(self._executability_conflicts())
590
conflicts.extend(self._overwrite_conflicts())
593
def _add_tree_children(self):
594
"""Add all the children of all active parents to the known paths.
596
Active parents are those which gain children, and those which are
597
removed. This is a necessary first step in detecting conflicts.
599
parents = self.by_parent().keys()
600
parents.extend([t for t in self._removed_contents if
601
self.tree_kind(t) == 'directory'])
602
for trans_id in self._removed_id:
603
file_id = self.tree_file_id(trans_id)
604
if file_id is not None:
605
if self._tree.inventory[file_id].kind == 'directory':
606
parents.append(trans_id)
607
elif self.tree_kind(trans_id) == 'directory':
608
parents.append(trans_id)
610
for parent_id in parents:
611
# ensure that all children are registered with the transaction
612
list(self.iter_tree_children(parent_id))
614
def iter_tree_children(self, parent_id):
615
"""Iterate through the entry's tree children, if any"""
617
path = self._tree_id_paths[parent_id]
621
children = os.listdir(self._tree.abspath(path))
623
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
627
for child in children:
628
childpath = joinpath(path, child)
629
if self._tree.is_control_filename(childpath):
631
yield self.trans_id_tree_path(childpath)
633
def has_named_child(self, by_parent, parent_id, name):
635
children = by_parent[parent_id]
638
for child in children:
639
if self.final_name(child) == name:
642
path = self._tree_id_paths[parent_id]
645
childpath = joinpath(path, name)
646
child_id = self._tree_path_ids.get(childpath)
648
return lexists(self._tree.abspath(childpath))
650
if self.final_parent(child_id) != parent_id:
652
if child_id in self._removed_contents:
653
# XXX What about dangling file-ids?
658
def _parent_loops(self):
659
"""No entry should be its own ancestor"""
661
for trans_id in self._new_parent:
664
while parent_id is not ROOT_PARENT:
667
parent_id = self.final_parent(parent_id)
670
if parent_id == trans_id:
671
conflicts.append(('parent loop', trans_id))
672
if parent_id in seen:
676
def _unversioned_parents(self, by_parent):
677
"""If parent directories are versioned, children must be versioned."""
679
for parent_id, children in by_parent.iteritems():
680
if parent_id is ROOT_PARENT:
682
if self.final_file_id(parent_id) is not None:
684
for child_id in children:
685
if self.final_file_id(child_id) is not None:
686
conflicts.append(('unversioned parent', parent_id))
690
def _improper_versioning(self):
691
"""Cannot version a file with no contents, or a bad type.
693
However, existing entries with no contents are okay.
696
for trans_id in self._new_id.iterkeys():
698
kind = self.final_kind(trans_id)
700
conflicts.append(('versioning no contents', trans_id))
702
if not InventoryEntry.versionable_kind(kind):
703
conflicts.append(('versioning bad kind', trans_id, kind))
706
def _executability_conflicts(self):
707
"""Check for bad executability changes.
709
Only versioned files may have their executability set, because
710
1. only versioned entries can have executability under windows
711
2. only files can be executable. (The execute bit on a directory
712
does not indicate searchability)
715
for trans_id in self._new_executability:
716
if self.final_file_id(trans_id) is None:
717
conflicts.append(('unversioned executability', trans_id))
720
non_file = self.final_kind(trans_id) != "file"
724
conflicts.append(('non-file executability', trans_id))
727
def _overwrite_conflicts(self):
728
"""Check for overwrites (not permitted on Win32)"""
730
for trans_id in self._new_contents:
732
self.tree_kind(trans_id)
735
if trans_id not in self._removed_contents:
736
conflicts.append(('overwrite', trans_id,
737
self.final_name(trans_id)))
740
def _duplicate_entries(self, by_parent):
741
"""No directory may have two entries with the same name."""
743
if (self._new_name, self._new_parent) == ({}, {}):
745
for children in by_parent.itervalues():
746
name_ids = [(self.final_name(t), t) for t in children]
747
if not self._case_sensitive_target:
748
name_ids = [(n.lower(), t) for n, t in name_ids]
752
for name, trans_id in name_ids:
754
kind = self.final_kind(trans_id)
757
file_id = self.final_file_id(trans_id)
758
if kind is None and file_id is None:
760
if name == last_name:
761
conflicts.append(('duplicate', last_trans_id, trans_id,
764
last_trans_id = trans_id
767
def _duplicate_ids(self):
768
"""Each inventory id may only be used once"""
770
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
772
all_ids = self._tree.all_file_ids()
773
active_tree_ids = all_ids.difference(removed_tree_ids)
774
for trans_id, file_id in self._new_id.iteritems():
775
if file_id in active_tree_ids:
776
old_trans_id = self.trans_id_tree_file_id(file_id)
777
conflicts.append(('duplicate id', old_trans_id, trans_id))
780
def _parent_type_conflicts(self, by_parent):
781
"""parents must have directory 'contents'."""
783
for parent_id, children in by_parent.iteritems():
784
if parent_id is ROOT_PARENT:
786
if not self._any_contents(children):
788
for child in children:
790
self.final_kind(child)
794
kind = self.final_kind(parent_id)
798
conflicts.append(('missing parent', parent_id))
799
elif kind != "directory":
800
conflicts.append(('non-directory parent', parent_id))
803
def _any_contents(self, trans_ids):
804
"""Return true if any of the trans_ids, will have contents."""
805
for trans_id in trans_ids:
807
kind = self.final_kind(trans_id)
813
def _limbo_name(self, trans_id):
814
"""Generate the limbo name of a file"""
815
limbo_name = self._limbo_files.get(trans_id)
816
if limbo_name is not None:
818
parent = self._new_parent.get(trans_id)
819
# if the parent directory is already in limbo (e.g. when building a
820
# tree), choose a limbo name inside the parent, to reduce further
822
use_direct_path = False
823
if self._new_contents.get(parent) == 'directory':
824
filename = self._new_name.get(trans_id)
825
if filename is not None:
826
if parent not in self._limbo_children:
827
self._limbo_children[parent] = set()
828
self._limbo_children_names[parent] = {}
829
use_direct_path = True
830
# the direct path can only be used if no other file has
831
# already taken this pathname, i.e. if the name is unused, or
832
# if it is already associated with this trans_id.
833
elif self._case_sensitive_target:
834
if (self._limbo_children_names[parent].get(filename)
835
in (trans_id, None)):
836
use_direct_path = True
838
for l_filename, l_trans_id in\
839
self._limbo_children_names[parent].iteritems():
840
if l_trans_id == trans_id:
842
if l_filename.lower() == filename.lower():
845
use_direct_path = True
848
limbo_name = pathjoin(self._limbo_files[parent], filename)
849
self._limbo_children[parent].add(trans_id)
850
self._limbo_children_names[parent][filename] = trans_id
852
limbo_name = pathjoin(self._limbodir, trans_id)
853
self._needs_rename.add(trans_id)
854
self._limbo_files[trans_id] = limbo_name
857
def _set_executability(self, path, entry, trans_id):
858
"""Set the executability of versioned files """
859
new_executability = self._new_executability[trans_id]
860
entry.executable = new_executability
861
if supports_executable():
862
abspath = self._tree.abspath(path)
863
current_mode = os.stat(abspath).st_mode
864
if new_executability:
867
to_mode = current_mode | (0100 & ~umask)
868
# Enable x-bit for others only if they can read it.
869
if current_mode & 0004:
870
to_mode |= 0001 & ~umask
871
if current_mode & 0040:
872
to_mode |= 0010 & ~umask
874
to_mode = current_mode & ~0111
875
os.chmod(abspath, to_mode)
877
def _new_entry(self, name, parent_id, file_id):
878
"""Helper function to create a new filesystem entry."""
879
trans_id = self.create_path(name, parent_id)
880
if file_id is not None:
881
self.version_file(file_id, trans_id)
884
def new_file(self, name, parent_id, contents, file_id=None,
886
"""Convenience method to create files.
888
name is the name of the file to create.
889
parent_id is the transaction id of the parent directory of the file.
890
contents is an iterator of bytestrings, which will be used to produce
892
:param file_id: The inventory ID of the file, if it is to be versioned.
893
:param executable: Only valid when a file_id has been supplied.
895
trans_id = self._new_entry(name, parent_id, file_id)
896
# TODO: rather than scheduling a set_executable call,
897
# have create_file create the file with the right mode.
898
self.create_file(contents, trans_id)
899
if executable is not None:
900
self.set_executability(executable, trans_id)
903
def new_directory(self, name, parent_id, file_id=None):
904
"""Convenience method to create directories.
906
name is the name of the directory to create.
907
parent_id is the transaction id of the parent directory of the
909
file_id is the inventory ID of the directory, if it is to be versioned.
911
trans_id = self._new_entry(name, parent_id, file_id)
912
self.create_directory(trans_id)
915
def new_symlink(self, name, parent_id, target, file_id=None):
916
"""Convenience method to create symbolic link.
918
name is the name of the symlink to create.
919
parent_id is the transaction id of the parent directory of the symlink.
920
target is a bytestring of the target of the symlink.
921
file_id is the inventory ID of the file, if it is to be versioned.
923
trans_id = self._new_entry(name, parent_id, file_id)
924
self.create_symlink(target, trans_id)
927
def _affected_ids(self):
928
"""Return the set of transform ids affected by the transform"""
929
trans_ids = set(self._removed_id)
930
trans_ids.update(self._new_id.keys())
931
trans_ids.update(self._removed_contents)
932
trans_ids.update(self._new_contents.keys())
933
trans_ids.update(self._new_executability.keys())
934
trans_ids.update(self._new_name.keys())
935
trans_ids.update(self._new_parent.keys())
938
def _get_file_id_maps(self):
939
"""Return mapping of file_ids to trans_ids in the to and from states"""
940
trans_ids = self._affected_ids()
943
# Build up two dicts: trans_ids associated with file ids in the
944
# FROM state, vs the TO state.
945
for trans_id in trans_ids:
946
from_file_id = self.tree_file_id(trans_id)
947
if from_file_id is not None:
948
from_trans_ids[from_file_id] = trans_id
949
to_file_id = self.final_file_id(trans_id)
950
if to_file_id is not None:
951
to_trans_ids[to_file_id] = trans_id
952
return from_trans_ids, to_trans_ids
954
def _from_file_data(self, from_trans_id, from_versioned, file_id):
955
"""Get data about a file in the from (tree) state
957
Return a (name, parent, kind, executable) tuple
959
from_path = self._tree_id_paths.get(from_trans_id)
961
# get data from working tree if versioned
962
from_entry = self._tree.inventory[file_id]
963
from_name = from_entry.name
964
from_parent = from_entry.parent_id
967
if from_path is None:
968
# File does not exist in FROM state
972
# File exists, but is not versioned. Have to use path-
974
from_name = os.path.basename(from_path)
975
tree_parent = self.get_tree_parent(from_trans_id)
976
from_parent = self.tree_file_id(tree_parent)
977
if from_path is not None:
978
from_kind, from_executable, from_stats = \
979
self._tree._comparison_data(from_entry, from_path)
982
from_executable = False
983
return from_name, from_parent, from_kind, from_executable
985
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
986
"""Get data about a file in the to (target) state
988
Return a (name, parent, kind, executable) tuple
990
to_name = self.final_name(to_trans_id)
992
to_kind = self.final_kind(to_trans_id)
995
to_parent = self.final_file_id(self.final_parent(to_trans_id))
996
if to_trans_id in self._new_executability:
997
to_executable = self._new_executability[to_trans_id]
998
elif to_trans_id == from_trans_id:
999
to_executable = from_executable
1001
to_executable = False
1002
return to_name, to_parent, to_kind, to_executable
1004
def iter_changes(self):
1005
"""Produce output in the same format as Tree.iter_changes.
1007
Will produce nonsensical results if invoked while inventory/filesystem
1008
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1010
This reads the Transform, but only reproduces changes involving a
1011
file_id. Files that are not versioned in either of the FROM or TO
1012
states are not reflected.
1014
final_paths = FinalPaths(self)
1015
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1017
# Now iterate through all active file_ids
1018
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1020
from_trans_id = from_trans_ids.get(file_id)
1021
# find file ids, and determine versioning state
1022
if from_trans_id is None:
1023
from_versioned = False
1024
from_trans_id = to_trans_ids[file_id]
1026
from_versioned = True
1027
to_trans_id = to_trans_ids.get(file_id)
1028
if to_trans_id is None:
1029
to_versioned = False
1030
to_trans_id = from_trans_id
1034
from_name, from_parent, from_kind, from_executable = \
1035
self._from_file_data(from_trans_id, from_versioned, file_id)
1037
to_name, to_parent, to_kind, to_executable = \
1038
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1040
if not from_versioned:
1043
from_path = self._tree_id_paths.get(from_trans_id)
1044
if not to_versioned:
1047
to_path = final_paths.get_path(to_trans_id)
1048
if from_kind != to_kind:
1050
elif to_kind in ('file', 'symlink') and (
1051
to_trans_id != from_trans_id or
1052
to_trans_id in self._new_contents):
1054
if (not modified and from_versioned == to_versioned and
1055
from_parent==to_parent and from_name == to_name and
1056
from_executable == to_executable):
1058
results.append((file_id, (from_path, to_path), modified,
1059
(from_versioned, to_versioned),
1060
(from_parent, to_parent),
1061
(from_name, to_name),
1062
(from_kind, to_kind),
1063
(from_executable, to_executable)))
1064
return iter(sorted(results, key=lambda x:x[1]))
1066
def get_preview_tree(self):
1067
"""Return a tree representing the result of the transform.
1069
This tree only supports the subset of Tree functionality required
1070
by show_diff_trees. It must only be compared to tt._tree.
1072
return _PreviewTree(self)
1075
class TreeTransform(TreeTransformBase):
1076
"""Represent a tree transformation.
1078
This object is designed to support incremental generation of the transform,
1081
However, it gives optimum performance when parent directories are created
1082
before their contents. The transform is then able to put child files
1083
directly in their parent directory, avoiding later renames.
1085
It is easy to produce malformed transforms, but they are generally
1086
harmless. Attempting to apply a malformed transform will cause an
1087
exception to be raised before any modifications are made to the tree.
1089
Many kinds of malformed transforms can be corrected with the
1090
resolve_conflicts function. The remaining ones indicate programming error,
1091
such as trying to create a file with no path.
1093
Two sets of file creation methods are supplied. Convenience methods are:
1098
These are composed of the low-level methods:
1100
* create_file or create_directory or create_symlink
1104
Transform/Transaction ids
1105
-------------------------
1106
trans_ids are temporary ids assigned to all files involved in a transform.
1107
It's possible, even common, that not all files in the Tree have trans_ids.
1109
trans_ids are used because filenames and file_ids are not good enough
1110
identifiers; filenames change, and not all files have file_ids. File-ids
1111
are also associated with trans-ids, so that moving a file moves its
1114
trans_ids are only valid for the TreeTransform that generated them.
1118
Limbo is a temporary directory use to hold new versions of files.
1119
Files are added to limbo by create_file, create_directory, create_symlink,
1120
and their convenience variants (new_*). Files may be removed from limbo
1121
using cancel_creation. Files are renamed from limbo into their final
1122
location as part of TreeTransform.apply
1124
Limbo must be cleaned up, by either calling TreeTransform.apply or
1125
calling TreeTransform.finalize.
1127
Files are placed into limbo inside their parent directories, where
1128
possible. This reduces subsequent renames, and makes operations involving
1129
lots of files faster. This optimization is only possible if the parent
1130
directory is created *before* creating any of its children, so avoid
1131
creating children before parents, where possible.
1135
This temporary directory is used by _FileMover for storing files that are
1136
about to be deleted. In case of rollback, the files will be restored.
1137
FileMover does not delete files until it is sure that a rollback will not
1140
def __init__(self, tree, pb=DummyProgress()):
1141
"""Note: a tree_write lock is taken on the tree.
1143
Use TreeTransform.finalize() to release the lock (can be omitted if
1144
TreeTransform.apply() called).
1146
tree.lock_tree_write()
1149
control_files = tree._control_files
1150
limbodir = urlutils.local_path_from_url(
1151
control_files.controlfilename('limbo'))
1155
if e.errno == errno.EEXIST:
1156
raise ExistingLimbo(limbodir)
1157
deletiondir = urlutils.local_path_from_url(
1158
control_files.controlfilename('pending-deletion'))
1160
os.mkdir(deletiondir)
1162
if e.errno == errno.EEXIST:
1163
raise errors.ExistingPendingDeletion(deletiondir)
1168
TreeTransformBase.__init__(self, tree, limbodir, pb,
1169
tree.case_sensitive)
1170
self._deletiondir = deletiondir
1172
def apply(self, no_conflicts=False, _mover=None):
1173
"""Apply all changes to the inventory and filesystem.
1175
If filesystem or inventory conflicts are present, MalformedTransform
1178
If apply succeeds, finalize is not necessary.
1180
:param no_conflicts: if True, the caller guarantees there are no
1181
conflicts, so no check is made.
1182
:param _mover: Supply an alternate FileMover, for testing
1184
if not no_conflicts:
1185
conflicts = self.find_conflicts()
1186
if len(conflicts) != 0:
1187
raise MalformedTransform(conflicts=conflicts)
1188
inventory_delta = []
1189
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1192
mover = _FileMover()
1196
child_pb.update('Apply phase', 0, 2)
1197
self._apply_removals(inventory_delta, mover)
1198
child_pb.update('Apply phase', 1, 2)
1199
modified_paths = self._apply_insertions(inventory_delta, mover)
1204
mover.apply_deletions()
1207
self._tree.apply_inventory_delta(inventory_delta)
1210
return _TransformResults(modified_paths, self.rename_count)
1212
def _apply_removals(self, inventory_delta, mover):
1213
"""Perform tree operations that remove directory/inventory names.
1215
That is, delete files that are to be deleted, and put any files that
1216
need renaming into limbo. This must be done in strict child-to-parent
1219
tree_paths = list(self._tree_path_ids.iteritems())
1220
tree_paths.sort(reverse=True)
1221
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1223
for num, data in enumerate(tree_paths):
1224
path, trans_id = data
1225
child_pb.update('removing file', num, len(tree_paths))
1226
full_path = self._tree.abspath(path)
1227
if trans_id in self._removed_contents:
1228
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1230
elif trans_id in self._new_name or trans_id in \
1233
mover.rename(full_path, self._limbo_name(trans_id))
1235
if e.errno != errno.ENOENT:
1238
self.rename_count += 1
1239
if trans_id in self._removed_id:
1240
if trans_id == self._new_root:
1241
file_id = self._tree.get_root_id()
1243
file_id = self.tree_file_id(trans_id)
1244
assert file_id is not None
1245
# File-id isn't really being deleted, just moved
1246
if file_id in self._r_new_id:
1248
inventory_delta.append((path, None, file_id, None))
1252
def _apply_insertions(self, 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))
1267
if trans_id in self._new_contents or \
1268
self.path_changed(trans_id):
1269
full_path = self._tree.abspath(path)
1270
if trans_id in self._needs_rename:
1272
mover.rename(self._limbo_name(trans_id), full_path)
1274
# We may be renaming a dangling inventory id
1275
if e.errno != errno.ENOENT:
1278
self.rename_count += 1
1279
if trans_id in self._new_contents:
1280
modified_paths.append(full_path)
1281
completed_new.append(trans_id)
1282
file_id = self.final_file_id(trans_id)
1283
if file_id is not None and (trans_id in self._new_id or
1284
trans_id in self._new_name or trans_id in self._new_parent
1285
or trans_id in self._new_executability):
1287
kind = self.final_kind(trans_id)
1289
kind = self._tree.stored_kind(file_id)
1290
if trans_id in self._new_reference_revision:
1291
new_entry = inventory.TreeReference(
1292
self.final_file_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.final_file_id(trans_id))
1302
old_path = self._tree.id2path(new_entry.file_id)
1303
except errors.NoSuchId:
1305
inventory_delta.append((old_path, path, new_entry.file_id,
1308
if trans_id in self._new_executability:
1309
self._set_executability(path, new_entry, trans_id)
1312
for trans_id in completed_new:
1313
del self._new_contents[trans_id]
1314
return modified_paths
1317
class TransformPreview(TreeTransformBase):
1318
"""A TreeTransform for generating preview trees.
1320
Unlike TreeTransform, this version works when the input tree is a
1321
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1322
unversioned files in the input tree.
1325
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1327
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1328
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1330
def canonical_path(self, path):
1333
def tree_kind(self, trans_id):
1334
path = self._tree_id_paths.get(trans_id)
1336
raise NoSuchFile(None)
1337
file_id = self._tree.path2id(path)
1338
return self._tree.kind(file_id)
1340
def _set_mode(self, trans_id, mode_id, typefunc):
1341
"""Set the mode of new file contents.
1342
The mode_id is the existing file to get the mode from (often the same
1343
as trans_id). The operation is only performed if there's a mode match
1344
according to typefunc.
1346
# is it ok to ignore this? probably
1349
def iter_tree_children(self, parent_id):
1350
"""Iterate through the entry's tree children, if any"""
1352
path = self._tree_id_paths[parent_id]
1355
file_id = self.tree_file_id(parent_id)
1356
for child in self._tree.inventory[file_id].children.iterkeys():
1357
childpath = joinpath(path, child)
1358
yield self.trans_id_tree_path(childpath)
1361
class _PreviewTree(tree.Tree):
1362
"""Partial implementation of Tree to support show_diff_trees"""
1364
def __init__(self, transform):
1365
self._transform = transform
1366
self._final_paths = FinalPaths(transform)
1368
def _changes(self, file_id):
1369
for changes in self._transform.iter_changes():
1370
if changes[0] == file_id:
1373
def _content_change(self, file_id):
1374
"""Return True if the content of this file changed"""
1375
changes = self._changes(file_id)
1376
# changes[2] is true if the file content changed. See
1377
# InterTree.iter_changes.
1378
return (changes is not None and changes[2])
1380
def _get_file_revision(self, file_id, vf, tree_revision):
1381
return self._transform._tree._get_file_revision(file_id, vf,
1384
def _stat_limbo_file(self, file_id):
1385
trans_id = self._transform.trans_id_file_id(file_id)
1386
name = self._transform._limbo_name(trans_id)
1387
return os.lstat(name)
1389
def lock_read(self):
1390
# Perhaps in theory, this should lock the TreeTransform?
1397
def inventory(self):
1398
"""This Tree does not use inventory as its backing data."""
1399
raise NotImplementedError(_PreviewTree.inventory)
1401
def get_root_id(self):
1402
return self._transform.final_file_id(self._transform.root)
1404
def all_file_ids(self):
1405
return self._transform._tree.all_file_ids()
1408
return iter(self.all_file_ids())
1410
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1411
"""See Tree.paths2ids"""
1412
to_find = set(specific_files)
1414
for (file_id, paths, changed, versioned, parent, name, kind,
1415
executable) in self._transform.iter_changes():
1416
if paths[1] in to_find:
1417
result.append(file_id)
1418
to_find.remove(paths[1])
1419
result.update(self._transform._tree.paths2ids(to_find,
1420
trees=[], require_versioned=require_versioned))
1423
def path2id(self, path):
1424
return self._transform._tree.path2id(path)
1426
def id2path(self, file_id):
1427
trans_id = self._transform.trans_id_file_id(file_id)
1429
return self._final_paths._determine_path(trans_id)
1431
raise errors.NoSuchId(self, file_id)
1433
def iter_entries_by_dir(self, specific_file_ids=None):
1434
return self._transform._tree.iter_entries_by_dir(specific_file_ids)
1436
def kind(self, file_id):
1437
trans_id = self._transform.trans_id_file_id(file_id)
1438
return self._transform.final_kind(trans_id)
1440
def stored_kind(self, file_id):
1441
return self._transform._tree.stored_kind(file_id)
1443
def get_file_mtime(self, file_id, path=None):
1444
"""See Tree.get_file_mtime"""
1445
if not self._content_change(file_id):
1446
return self._transform._tree.get_file_mtime(file_id, path)
1447
return self._stat_limbo_file(file_id).st_mtime
1449
def get_file_size(self, file_id):
1450
"""See Tree.get_file_size"""
1451
if self.kind(file_id) == 'file':
1452
return self._transform._tree.get_file_size(file_id)
1456
def get_file_sha1(self, file_id, path=None, stat_value=None):
1457
return self._transform._tree.get_file_sha1(file_id)
1459
def is_executable(self, file_id, path=None):
1460
return self._transform._tree.is_executable(file_id, path)
1462
def path_content_summary(self, path):
1463
return self._transform._tree.path_content_summary(path)
1465
def iter_changes(self, from_tree, include_unchanged=False,
1466
specific_files=None, pb=None, extra_trees=None,
1467
require_versioned=True, want_unversioned=False):
1468
"""See InterTree.iter_changes.
1470
This implementation does not support include_unchanged, specific_files,
1471
or want_unversioned. extra_trees, require_versioned, and pb are
1474
if from_tree is not self._transform._tree:
1475
raise ValueError('from_tree must be transform source tree.')
1476
if include_unchanged:
1477
raise ValueError('include_unchanged is not supported')
1478
if specific_files is not None:
1479
raise ValueError('specific_files is not supported')
1480
if want_unversioned:
1481
raise ValueError('want_unversioned is not supported')
1482
return self._transform.iter_changes()
1484
def get_file(self, file_id, path=None):
1485
"""See Tree.get_file"""
1486
if not self._content_change(file_id):
1487
return self._transform._tree.get_file(file_id, path)
1488
trans_id = self._transform.trans_id_file_id(file_id)
1489
name = self._transform._limbo_name(trans_id)
1490
return open(name, 'rb')
1492
def get_file_text(self, file_id):
1493
text_file = self.get_file(file_id)
1495
return text_file.read()
1499
def annotate_iter(self, file_id,
1500
default_revision=_mod_revision.CURRENT_REVISION):
1501
return self._transform._tree.annotate_iter(file_id,
1502
default_revision=default_revision)
1504
def get_symlink_target(self, file_id):
1505
"""See Tree.get_symlink_target"""
1506
if not self._content_change(file_id):
1507
return self._transform._tree.get_symlink_target(file_id)
1508
trans_id = self._transform.trans_id_file_id(file_id)
1509
name = self._transform._limbo_name(trans_id)
1510
return os.readlink(name)
1512
def list_files(self, include_root=False):
1513
return self._transform._tree.list_files(include_root)
1515
def walkdirs(self, prefix=""):
1516
return self._transform._tree.walkdirs(prefix)
1518
def get_parent_ids(self):
1519
return self._transform._tree.get_parent_ids()
1521
def get_revision_tree(self, revision_id):
1522
return self._transform._tree.get_revision_tree(revision_id)
1525
def joinpath(parent, child):
1526
"""Join tree-relative paths, handling the tree root specially"""
1527
if parent is None or parent == "":
1530
return pathjoin(parent, child)
1533
class FinalPaths(object):
1534
"""Make path calculation cheap by memoizing paths.
1536
The underlying tree must not be manipulated between calls, or else
1537
the results will likely be incorrect.
1539
def __init__(self, transform):
1540
object.__init__(self)
1541
self._known_paths = {}
1542
self.transform = transform
1544
def _determine_path(self, trans_id):
1545
if trans_id == self.transform.root:
1547
name = self.transform.final_name(trans_id)
1548
parent_id = self.transform.final_parent(trans_id)
1549
if parent_id == self.transform.root:
1552
return pathjoin(self.get_path(parent_id), name)
1554
def get_path(self, trans_id):
1555
"""Find the final path associated with a trans_id"""
1556
if trans_id not in self._known_paths:
1557
self._known_paths[trans_id] = self._determine_path(trans_id)
1558
return self._known_paths[trans_id]
1561
def topology_sorted_ids(tree):
1562
"""Determine the topological order of the ids in a tree"""
1563
file_ids = list(tree)
1564
file_ids.sort(key=tree.id2path)
1568
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
1569
"""Create working tree for a branch, using a TreeTransform.
1571
This function should be used on empty trees, having a tree root at most.
1572
(see merge and revert functionality for working with existing trees)
1574
Existing files are handled like so:
1576
- Existing bzrdirs take precedence over creating new items. They are
1577
created as '%s.diverted' % name.
1578
- Otherwise, if the content on disk matches the content we are building,
1579
it is silently replaced.
1580
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1582
:param tree: The tree to convert wt into a copy of
1583
:param wt: The working tree that files will be placed into
1584
:param accelerator_tree: A tree which can be used for retrieving file
1585
contents more quickly than tree itself, i.e. a workingtree. tree
1586
will be used for cases where accelerator_tree's content is different.
1587
:param hardlink: If true, hard-link files to accelerator_tree, where
1588
possible. accelerator_tree must implement abspath, i.e. be a
1591
wt.lock_tree_write()
1595
if accelerator_tree is not None:
1596
accelerator_tree.lock_read()
1598
return _build_tree(tree, wt, accelerator_tree, hardlink)
1600
if accelerator_tree is not None:
1601
accelerator_tree.unlock()
1608
def _build_tree(tree, wt, accelerator_tree, hardlink):
1609
"""See build_tree."""
1610
for num, _unused in enumerate(wt.all_file_ids()):
1611
if num > 0: # more than just a root
1612
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1614
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
pp = ProgressPhase("Build phase", 2, top_pb)
1616
if tree.inventory.root is not None:
1617
# This is kind of a hack: we should be altering the root
1618
# as part of the regular tree shape diff logic.
1619
# The conditional test here is to avoid doing an
1620
# expensive operation (flush) every time the root id
1621
# is set within the tree, nor setting the root and thus
1622
# marking the tree as dirty, because we use two different
1623
# idioms here: tree interfaces and inventory interfaces.
1624
if wt.get_root_id() != tree.get_root_id():
1625
wt.set_root_id(tree.get_root_id())
1627
tt = TreeTransform(wt)
1631
file_trans_id[wt.get_root_id()] = \
1632
tt.trans_id_tree_file_id(wt.get_root_id())
1633
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1635
deferred_contents = []
1637
for num, (tree_path, entry) in \
1638
enumerate(tree.inventory.iter_entries_by_dir()):
1639
pb.update("Building tree", num - len(deferred_contents),
1640
len(tree.inventory))
1641
if entry.parent_id is None:
1644
file_id = entry.file_id
1645
target_path = wt.abspath(tree_path)
1647
kind = file_kind(target_path)
1651
if kind == "directory":
1653
bzrdir.BzrDir.open(target_path)
1654
except errors.NotBranchError:
1658
if (file_id not in divert and
1659
_content_match(tree, entry, file_id, kind,
1661
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1662
if kind == 'directory':
1664
if entry.parent_id not in file_trans_id:
1665
raise AssertionError(
1666
'entry %s parent id %r is not in file_trans_id %r'
1667
% (entry, entry.parent_id, file_trans_id))
1668
parent_id = file_trans_id[entry.parent_id]
1669
if entry.kind == 'file':
1670
# We *almost* replicate new_by_entry, so that we can defer
1671
# getting the file text, and get them all at once.
1672
trans_id = tt.create_path(entry.name, parent_id)
1673
file_trans_id[file_id] = trans_id
1674
tt.version_file(entry.file_id, trans_id)
1675
executable = tree.is_executable(entry.file_id, tree_path)
1676
if executable is not None:
1677
tt.set_executability(executable, trans_id)
1678
deferred_contents.append((entry.file_id, trans_id))
1680
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1683
new_trans_id = file_trans_id[file_id]
1684
old_parent = tt.trans_id_tree_path(tree_path)
1685
_reparent_children(tt, old_parent, new_trans_id)
1686
offset = num + 1 - len(deferred_contents)
1687
_create_files(tt, tree, deferred_contents, pb, offset,
1688
accelerator_tree, hardlink)
1692
divert_trans = set(file_trans_id[f] for f in divert)
1693
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1694
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1695
conflicts = cook_conflicts(raw_conflicts, tt)
1696
for conflict in conflicts:
1699
wt.add_conflicts(conflicts)
1700
except errors.UnsupportedOperation:
1702
result = tt.apply(no_conflicts=True)
1709
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1711
total = len(desired_files) + offset
1712
if accelerator_tree is None:
1713
new_desired_files = desired_files
1715
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1716
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1717
in iter if not (c or e[0] != e[1]))
1718
new_desired_files = []
1720
for file_id, trans_id in desired_files:
1721
accelerator_path = unchanged.get(file_id)
1722
if accelerator_path is None:
1723
new_desired_files.append((file_id, trans_id))
1725
pb.update('Adding file contents', count + offset, total)
1727
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1730
contents = accelerator_tree.get_file(file_id, accelerator_path)
1732
tt.create_file(contents, trans_id)
1737
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1738
new_desired_files)):
1739
tt.create_file(contents, trans_id)
1740
pb.update('Adding file contents', count + offset, total)
1743
def _reparent_children(tt, old_parent, new_parent):
1744
for child in tt.iter_tree_children(old_parent):
1745
tt.adjust_path(tt.final_name(child), new_parent, child)
1747
def _reparent_transform_children(tt, old_parent, new_parent):
1748
by_parent = tt.by_parent()
1749
for child in by_parent[old_parent]:
1750
tt.adjust_path(tt.final_name(child), new_parent, child)
1751
return by_parent[old_parent]
1753
def _content_match(tree, entry, file_id, kind, target_path):
1754
if entry.kind != kind:
1756
if entry.kind == "directory":
1758
if entry.kind == "file":
1759
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1761
elif entry.kind == "symlink":
1762
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1767
def resolve_checkout(tt, conflicts, divert):
1768
new_conflicts = set()
1769
for c_type, conflict in ((c[0], c) for c in conflicts):
1770
# Anything but a 'duplicate' would indicate programmer error
1771
assert c_type == 'duplicate', c_type
1772
# Now figure out which is new and which is old
1773
if tt.new_contents(conflict[1]):
1774
new_file = conflict[1]
1775
old_file = conflict[2]
1777
new_file = conflict[2]
1778
old_file = conflict[1]
1780
# We should only get here if the conflict wasn't completely
1782
final_parent = tt.final_parent(old_file)
1783
if new_file in divert:
1784
new_name = tt.final_name(old_file)+'.diverted'
1785
tt.adjust_path(new_name, final_parent, new_file)
1786
new_conflicts.add((c_type, 'Diverted to',
1787
new_file, old_file))
1789
new_name = tt.final_name(old_file)+'.moved'
1790
tt.adjust_path(new_name, final_parent, old_file)
1791
new_conflicts.add((c_type, 'Moved existing file to',
1792
old_file, new_file))
1793
return new_conflicts
1796
def new_by_entry(tt, entry, parent_id, tree):
1797
"""Create a new file according to its inventory entry"""
1801
contents = tree.get_file(entry.file_id).readlines()
1802
executable = tree.is_executable(entry.file_id)
1803
return tt.new_file(name, parent_id, contents, entry.file_id,
1805
elif kind in ('directory', 'tree-reference'):
1806
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1807
if kind == 'tree-reference':
1808
tt.set_tree_reference(entry.reference_revision, trans_id)
1810
elif kind == 'symlink':
1811
target = tree.get_symlink_target(entry.file_id)
1812
return tt.new_symlink(name, parent_id, target, entry.file_id)
1814
raise errors.BadFileKindError(name, kind)
1817
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1818
"""Create new file contents according to an inventory entry."""
1819
if entry.kind == "file":
1821
lines = tree.get_file(entry.file_id).readlines()
1822
tt.create_file(lines, trans_id, mode_id=mode_id)
1823
elif entry.kind == "symlink":
1824
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1825
elif entry.kind == "directory":
1826
tt.create_directory(trans_id)
1829
def create_entry_executability(tt, entry, trans_id):
1830
"""Set the executability of a trans_id according to an inventory entry"""
1831
if entry.kind == "file":
1832
tt.set_executability(entry.executable, trans_id)
1835
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1836
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1839
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1840
"""Produce a backup-style name that appears to be available"""
1844
yield "%s.~%d~" % (name, counter)
1846
for new_name in name_gen():
1847
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1851
def _entry_changes(file_id, entry, working_tree):
1852
"""Determine in which ways the inventory entry has changed.
1854
Returns booleans: has_contents, content_mod, meta_mod
1855
has_contents means there are currently contents, but they differ
1856
contents_mod means contents need to be modified
1857
meta_mod means the metadata needs to be modified
1859
cur_entry = working_tree.inventory[file_id]
1861
working_kind = working_tree.kind(file_id)
1864
has_contents = False
1867
if has_contents is True:
1868
if entry.kind != working_kind:
1869
contents_mod, meta_mod = True, False
1871
cur_entry._read_tree_state(working_tree.id2path(file_id),
1873
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1874
cur_entry._forget_tree_state()
1875
return has_contents, contents_mod, meta_mod
1878
def revert(working_tree, target_tree, filenames, backups=False,
1879
pb=DummyProgress(), change_reporter=None):
1880
"""Revert a working tree's contents to those of a target tree."""
1881
target_tree.lock_read()
1882
tt = TreeTransform(working_tree, pb)
1884
pp = ProgressPhase("Revert phase", 3, pb)
1886
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1888
merge_modified = _alter_files(working_tree, target_tree, tt,
1889
child_pb, filenames, backups)
1893
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1895
raw_conflicts = resolve_conflicts(tt, child_pb,
1896
lambda t, c: conflict_pass(t, c, target_tree))
1899
conflicts = cook_conflicts(raw_conflicts, tt)
1901
change_reporter = delta._ChangeReporter(
1902
unversioned_filter=working_tree.is_ignored)
1903
delta.report_changes(tt.iter_changes(), change_reporter)
1904
for conflict in conflicts:
1908
working_tree.set_merge_modified(merge_modified)
1910
target_tree.unlock()
1916
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1918
merge_modified = working_tree.merge_modified()
1919
change_list = target_tree.iter_changes(working_tree,
1920
specific_files=specific_files, pb=pb)
1921
if target_tree.inventory.root is None:
1928
for id_num, (file_id, path, changed_content, versioned, parent, name,
1929
kind, executable) in enumerate(change_list):
1930
if skip_root and file_id[0] is not None and parent[0] is None:
1932
trans_id = tt.trans_id_file_id(file_id)
1935
keep_content = False
1936
if kind[0] == 'file' and (backups or kind[1] is None):
1937
wt_sha1 = working_tree.get_file_sha1(file_id)
1938
if merge_modified.get(file_id) != wt_sha1:
1939
# acquire the basis tree lazily to prevent the
1940
# expense of accessing it when it's not needed ?
1941
# (Guessing, RBC, 200702)
1942
if basis_tree is None:
1943
basis_tree = working_tree.basis_tree()
1944
basis_tree.lock_read()
1945
if file_id in basis_tree:
1946
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1948
elif kind[1] is None and not versioned[1]:
1950
if kind[0] is not None:
1951
if not keep_content:
1952
tt.delete_contents(trans_id)
1953
elif kind[1] is not None:
1954
parent_trans_id = tt.trans_id_file_id(parent[0])
1955
by_parent = tt.by_parent()
1956
backup_name = _get_backup_name(name[0], by_parent,
1957
parent_trans_id, tt)
1958
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1959
new_trans_id = tt.create_path(name[0], parent_trans_id)
1960
if versioned == (True, True):
1961
tt.unversion_file(trans_id)
1962
tt.version_file(file_id, new_trans_id)
1963
# New contents should have the same unix perms as old
1966
trans_id = new_trans_id
1967
if kind[1] == 'directory':
1968
tt.create_directory(trans_id)
1969
elif kind[1] == 'symlink':
1970
tt.create_symlink(target_tree.get_symlink_target(file_id),
1972
elif kind[1] == 'file':
1973
deferred_files.append((file_id, (trans_id, mode_id)))
1974
if basis_tree is None:
1975
basis_tree = working_tree.basis_tree()
1976
basis_tree.lock_read()
1977
new_sha1 = target_tree.get_file_sha1(file_id)
1978
if (file_id in basis_tree and new_sha1 ==
1979
basis_tree.get_file_sha1(file_id)):
1980
if file_id in merge_modified:
1981
del merge_modified[file_id]
1983
merge_modified[file_id] = new_sha1
1985
# preserve the execute bit when backing up
1986
if keep_content and executable[0] == executable[1]:
1987
tt.set_executability(executable[1], trans_id)
1989
assert kind[1] is None
1990
if versioned == (False, True):
1991
tt.version_file(file_id, trans_id)
1992
if versioned == (True, False):
1993
tt.unversion_file(trans_id)
1994
if (name[1] is not None and
1995
(name[0] != name[1] or parent[0] != parent[1])):
1997
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1998
if executable[0] != executable[1] and kind[1] == "file":
1999
tt.set_executability(executable[1], trans_id)
2000
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2002
tt.create_file(bytes, trans_id, mode_id)
2004
if basis_tree is not None:
2006
return merge_modified
2009
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2010
"""Make many conflict-resolution attempts, but die if they fail"""
2011
if pass_func is None:
2012
pass_func = conflict_pass
2013
new_conflicts = set()
2016
pb.update('Resolution pass', n+1, 10)
2017
conflicts = tt.find_conflicts()
2018
if len(conflicts) == 0:
2019
return new_conflicts
2020
new_conflicts.update(pass_func(tt, conflicts))
2021
raise MalformedTransform(conflicts=conflicts)
2026
def conflict_pass(tt, conflicts, path_tree=None):
2027
"""Resolve some classes of conflicts.
2029
:param tt: The transform to resolve conflicts in
2030
:param conflicts: The conflicts to resolve
2031
:param path_tree: A Tree to get supplemental paths from
2033
new_conflicts = set()
2034
for c_type, conflict in ((c[0], c) for c in conflicts):
2035
if c_type == 'duplicate id':
2036
tt.unversion_file(conflict[1])
2037
new_conflicts.add((c_type, 'Unversioned existing file',
2038
conflict[1], conflict[2], ))
2039
elif c_type == 'duplicate':
2040
# files that were renamed take precedence
2041
final_parent = tt.final_parent(conflict[1])
2042
if tt.path_changed(conflict[1]):
2043
existing_file, new_file = conflict[2], conflict[1]
2045
existing_file, new_file = conflict[1], conflict[2]
2046
new_name = tt.final_name(existing_file)+'.moved'
2047
tt.adjust_path(new_name, final_parent, existing_file)
2048
new_conflicts.add((c_type, 'Moved existing file to',
2049
existing_file, new_file))
2050
elif c_type == 'parent loop':
2051
# break the loop by undoing one of the ops that caused the loop
2053
while not tt.path_changed(cur):
2054
cur = tt.final_parent(cur)
2055
new_conflicts.add((c_type, 'Cancelled move', cur,
2056
tt.final_parent(cur),))
2057
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2059
elif c_type == 'missing parent':
2060
trans_id = conflict[1]
2062
tt.cancel_deletion(trans_id)
2063
new_conflicts.add(('deleting parent', 'Not deleting',
2068
tt.final_name(trans_id)
2070
if path_tree is not None:
2071
file_id = tt.final_file_id(trans_id)
2073
file_id = tt.inactive_file_id(trans_id)
2074
entry = path_tree.inventory[file_id]
2075
# special-case the other tree root (move its
2076
# children to current root)
2077
if entry.parent_id is None:
2079
moved = _reparent_transform_children(
2080
tt, trans_id, tt.root)
2082
new_conflicts.add((c_type, 'Moved to root',
2085
parent_trans_id = tt.trans_id_file_id(
2087
tt.adjust_path(entry.name, parent_trans_id,
2090
tt.create_directory(trans_id)
2091
new_conflicts.add((c_type, 'Created directory', trans_id))
2092
elif c_type == 'unversioned parent':
2093
file_id = tt.inactive_file_id(conflict[1])
2094
# special-case the other tree root (move its children instead)
2095
if path_tree and file_id in path_tree:
2096
if path_tree.inventory[file_id].parent_id is None:
2098
tt.version_file(file_id, conflict[1])
2099
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2100
elif c_type == 'non-directory parent':
2101
parent_id = conflict[1]
2102
parent_parent = tt.final_parent(parent_id)
2103
parent_name = tt.final_name(parent_id)
2104
parent_file_id = tt.final_file_id(parent_id)
2105
new_parent_id = tt.new_directory(parent_name + '.new',
2106
parent_parent, parent_file_id)
2107
_reparent_transform_children(tt, parent_id, new_parent_id)
2108
if parent_file_id is not None:
2109
tt.unversion_file(parent_id)
2110
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2111
return new_conflicts
2114
def cook_conflicts(raw_conflicts, tt):
2115
"""Generate a list of cooked conflicts, sorted by file path"""
2116
from bzrlib.conflicts import Conflict
2117
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2118
return sorted(conflict_iter, key=Conflict.sort_key)
2121
def iter_cook_conflicts(raw_conflicts, tt):
2122
from bzrlib.conflicts import Conflict
2124
for conflict in raw_conflicts:
2125
c_type = conflict[0]
2126
action = conflict[1]
2127
modified_path = fp.get_path(conflict[2])
2128
modified_id = tt.final_file_id(conflict[2])
2129
if len(conflict) == 3:
2130
yield Conflict.factory(c_type, action=action, path=modified_path,
2131
file_id=modified_id)
2134
conflicting_path = fp.get_path(conflict[3])
2135
conflicting_id = tt.final_file_id(conflict[3])
2136
yield Conflict.factory(c_type, action=action, path=modified_path,
2137
file_id=modified_id,
2138
conflict_path=conflicting_path,
2139
conflict_file_id=conflicting_id)
2142
class _FileMover(object):
2143
"""Moves and deletes files for TreeTransform, tracking operations"""
2146
self.past_renames = []
2147
self.pending_deletions = []
2149
def rename(self, from_, to):
2150
"""Rename a file from one path to another. Functions like os.rename"""
2152
os.rename(from_, to)
2154
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2155
raise errors.FileExists(to, str(e))
2157
self.past_renames.append((from_, to))
2159
def pre_delete(self, from_, to):
2160
"""Rename a file out of the way and mark it for deletion.
2162
Unlike os.unlink, this works equally well for files and directories.
2163
:param from_: The current file path
2164
:param to: A temporary path for the file
2166
self.rename(from_, to)
2167
self.pending_deletions.append(to)
2170
"""Reverse all renames that have been performed"""
2171
for from_, to in reversed(self.past_renames):
2172
os.rename(to, from_)
2173
# after rollback, don't reuse _FileMover
2175
pending_deletions = None
2177
def apply_deletions(self):
2178
"""Apply all marked deletions"""
2179
for path in self.pending_deletions:
2181
# after apply_deletions, don't reuse _FileMover
2183
pending_deletions = None
added
removed
bzrlib/transform.py
