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_directory(self, trans_id):
358
"""Schedule creation of a new directory.
360
See also new_directory.
362
os.mkdir(self._limbo_name(trans_id))
363
unique_add(self._new_contents, trans_id, 'directory')
365
def create_symlink(self, target, trans_id):
366
"""Schedule creation of a new symbolic link.
368
target is a bytestring.
369
See also new_symlink.
372
os.symlink(target, self._limbo_name(trans_id))
373
unique_add(self._new_contents, trans_id, 'symlink')
376
path = FinalPaths(self).get_path(trans_id)
379
raise UnableCreateSymlink(path=path)
381
def cancel_creation(self, trans_id):
382
"""Cancel the creation of new file contents."""
383
del self._new_contents[trans_id]
384
children = self._limbo_children.get(trans_id)
385
# if this is a limbo directory with children, move them before removing
387
if children is not None:
388
self._rename_in_limbo(children)
389
del self._limbo_children[trans_id]
390
del self._limbo_children_names[trans_id]
391
delete_any(self._limbo_name(trans_id))
393
def delete_contents(self, trans_id):
394
"""Schedule the contents of a path entry for deletion"""
395
self.tree_kind(trans_id)
396
self._removed_contents.add(trans_id)
398
def cancel_deletion(self, trans_id):
399
"""Cancel a scheduled deletion"""
400
self._removed_contents.remove(trans_id)
402
def unversion_file(self, trans_id):
403
"""Schedule a path entry to become unversioned"""
404
self._removed_id.add(trans_id)
406
def delete_versioned(self, trans_id):
407
"""Delete and unversion a versioned file"""
408
self.delete_contents(trans_id)
409
self.unversion_file(trans_id)
411
def set_executability(self, executability, trans_id):
412
"""Schedule setting of the 'execute' bit
413
To unschedule, set to None
415
if executability is None:
416
del self._new_executability[trans_id]
418
unique_add(self._new_executability, trans_id, executability)
420
def set_tree_reference(self, revision_id, trans_id):
421
"""Set the reference associated with a directory"""
422
unique_add(self._new_reference_revision, trans_id, revision_id)
424
def version_file(self, file_id, trans_id):
425
"""Schedule a file to become versioned."""
426
assert file_id is not None
427
unique_add(self._new_id, trans_id, file_id)
428
unique_add(self._r_new_id, file_id, trans_id)
430
def cancel_versioning(self, trans_id):
431
"""Undo a previous versioning of a file"""
432
file_id = self._new_id[trans_id]
433
del self._new_id[trans_id]
434
del self._r_new_id[file_id]
437
"""Determine the paths of all new and changed files"""
439
fp = FinalPaths(self)
440
for id_set in (self._new_name, self._new_parent, self._new_contents,
441
self._new_id, self._new_executability):
442
new_ids.update(id_set)
443
new_paths = [(fp.get_path(t), t) for t in new_ids]
447
def tree_kind(self, trans_id):
448
"""Determine the file kind in the working tree.
450
Raises NoSuchFile if the file does not exist
452
path = self._tree_id_paths.get(trans_id)
454
raise NoSuchFile(None)
456
return file_kind(self._tree.abspath(path))
458
if e.errno != errno.ENOENT:
461
raise NoSuchFile(path)
463
def final_kind(self, trans_id):
464
"""Determine the final file kind, after any changes applied.
466
Raises NoSuchFile if the file does not exist/has no contents.
467
(It is conceivable that a path would be created without the
468
corresponding contents insertion command)
470
if trans_id in self._new_contents:
471
return self._new_contents[trans_id]
472
elif trans_id in self._removed_contents:
473
raise NoSuchFile(None)
475
return self.tree_kind(trans_id)
477
def tree_file_id(self, trans_id):
478
"""Determine the file id associated with the trans_id in the tree"""
480
path = self._tree_id_paths[trans_id]
482
# the file is a new, unversioned file, or invalid trans_id
484
# the file is old; the old id is still valid
485
if self._new_root == trans_id:
486
return self._tree.get_root_id()
487
return self._tree.inventory.path2id(path)
489
def final_file_id(self, trans_id):
490
"""Determine the file id after any changes are applied, or None.
492
None indicates that the file will not be versioned after changes are
496
# there is a new id for this file
497
assert self._new_id[trans_id] is not None
498
return self._new_id[trans_id]
500
if trans_id in self._removed_id:
502
return self.tree_file_id(trans_id)
504
def inactive_file_id(self, trans_id):
505
"""Return the inactive file_id associated with a transaction id.
506
That is, the one in the tree or in non_present_ids.
507
The file_id may actually be active, too.
509
file_id = self.tree_file_id(trans_id)
510
if file_id is not None:
512
for key, value in self._non_present_ids.iteritems():
513
if value == trans_id:
516
def final_parent(self, trans_id):
517
"""Determine the parent file_id, after any changes are applied.
519
ROOT_PARENT is returned for the tree root.
522
return self._new_parent[trans_id]
524
return self.get_tree_parent(trans_id)
526
def final_name(self, trans_id):
527
"""Determine the final filename, after all changes are applied."""
529
return self._new_name[trans_id]
532
return os.path.basename(self._tree_id_paths[trans_id])
534
raise NoFinalPath(trans_id, self)
537
"""Return a map of parent: children for known parents.
539
Only new paths and parents of tree files with assigned ids are used.
542
items = list(self._new_parent.iteritems())
543
items.extend((t, self.final_parent(t)) for t in
544
self._tree_id_paths.keys())
545
for trans_id, parent_id in items:
546
if parent_id not in by_parent:
547
by_parent[parent_id] = set()
548
by_parent[parent_id].add(trans_id)
551
def path_changed(self, trans_id):
552
"""Return True if a trans_id's path has changed."""
553
return (trans_id in self._new_name) or (trans_id in self._new_parent)
555
def new_contents(self, trans_id):
556
return (trans_id in self._new_contents)
558
def find_conflicts(self):
559
"""Find any violations of inventory or filesystem invariants"""
560
if self._done is True:
561
raise ReusingTransform()
563
# ensure all children of all existent parents are known
564
# all children of non-existent parents are known, by definition.
565
self._add_tree_children()
566
by_parent = self.by_parent()
567
conflicts.extend(self._unversioned_parents(by_parent))
568
conflicts.extend(self._parent_loops())
569
conflicts.extend(self._duplicate_entries(by_parent))
570
conflicts.extend(self._duplicate_ids())
571
conflicts.extend(self._parent_type_conflicts(by_parent))
572
conflicts.extend(self._improper_versioning())
573
conflicts.extend(self._executability_conflicts())
574
conflicts.extend(self._overwrite_conflicts())
577
def _add_tree_children(self):
578
"""Add all the children of all active parents to the known paths.
580
Active parents are those which gain children, and those which are
581
removed. This is a necessary first step in detecting conflicts.
583
parents = self.by_parent().keys()
584
parents.extend([t for t in self._removed_contents if
585
self.tree_kind(t) == 'directory'])
586
for trans_id in self._removed_id:
587
file_id = self.tree_file_id(trans_id)
588
if file_id is not None:
589
if self._tree.inventory[file_id].kind == 'directory':
590
parents.append(trans_id)
591
elif self.tree_kind(trans_id) == 'directory':
592
parents.append(trans_id)
594
for parent_id in parents:
595
# ensure that all children are registered with the transaction
596
list(self.iter_tree_children(parent_id))
598
def iter_tree_children(self, parent_id):
599
"""Iterate through the entry's tree children, if any"""
601
path = self._tree_id_paths[parent_id]
605
children = os.listdir(self._tree.abspath(path))
607
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
611
for child in children:
612
childpath = joinpath(path, child)
613
if self._tree.is_control_filename(childpath):
615
yield self.trans_id_tree_path(childpath)
617
def has_named_child(self, by_parent, parent_id, name):
619
children = by_parent[parent_id]
622
for child in children:
623
if self.final_name(child) == name:
626
path = self._tree_id_paths[parent_id]
629
childpath = joinpath(path, name)
630
child_id = self._tree_path_ids.get(childpath)
632
return lexists(self._tree.abspath(childpath))
634
if self.final_parent(child_id) != parent_id:
636
if child_id in self._removed_contents:
637
# XXX What about dangling file-ids?
642
def _parent_loops(self):
643
"""No entry should be its own ancestor"""
645
for trans_id in self._new_parent:
648
while parent_id is not ROOT_PARENT:
651
parent_id = self.final_parent(parent_id)
654
if parent_id == trans_id:
655
conflicts.append(('parent loop', trans_id))
656
if parent_id in seen:
660
def _unversioned_parents(self, by_parent):
661
"""If parent directories are versioned, children must be versioned."""
663
for parent_id, children in by_parent.iteritems():
664
if parent_id is ROOT_PARENT:
666
if self.final_file_id(parent_id) is not None:
668
for child_id in children:
669
if self.final_file_id(child_id) is not None:
670
conflicts.append(('unversioned parent', parent_id))
674
def _improper_versioning(self):
675
"""Cannot version a file with no contents, or a bad type.
677
However, existing entries with no contents are okay.
680
for trans_id in self._new_id.iterkeys():
682
kind = self.final_kind(trans_id)
684
conflicts.append(('versioning no contents', trans_id))
686
if not InventoryEntry.versionable_kind(kind):
687
conflicts.append(('versioning bad kind', trans_id, kind))
690
def _executability_conflicts(self):
691
"""Check for bad executability changes.
693
Only versioned files may have their executability set, because
694
1. only versioned entries can have executability under windows
695
2. only files can be executable. (The execute bit on a directory
696
does not indicate searchability)
699
for trans_id in self._new_executability:
700
if self.final_file_id(trans_id) is None:
701
conflicts.append(('unversioned executability', trans_id))
704
non_file = self.final_kind(trans_id) != "file"
708
conflicts.append(('non-file executability', trans_id))
711
def _overwrite_conflicts(self):
712
"""Check for overwrites (not permitted on Win32)"""
714
for trans_id in self._new_contents:
716
self.tree_kind(trans_id)
719
if trans_id not in self._removed_contents:
720
conflicts.append(('overwrite', trans_id,
721
self.final_name(trans_id)))
724
def _duplicate_entries(self, by_parent):
725
"""No directory may have two entries with the same name."""
727
if (self._new_name, self._new_parent) == ({}, {}):
729
for children in by_parent.itervalues():
730
name_ids = [(self.final_name(t), t) for t in children]
731
if not self._case_sensitive_target:
732
name_ids = [(n.lower(), t) for n, t in name_ids]
736
for name, trans_id in name_ids:
738
kind = self.final_kind(trans_id)
741
file_id = self.final_file_id(trans_id)
742
if kind is None and file_id is None:
744
if name == last_name:
745
conflicts.append(('duplicate', last_trans_id, trans_id,
748
last_trans_id = trans_id
751
def _duplicate_ids(self):
752
"""Each inventory id may only be used once"""
754
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
756
active_tree_ids = set((f for f in self._tree.inventory if
757
f not in removed_tree_ids))
758
for trans_id, file_id in self._new_id.iteritems():
759
if file_id in active_tree_ids:
760
old_trans_id = self.trans_id_tree_file_id(file_id)
761
conflicts.append(('duplicate id', old_trans_id, trans_id))
764
def _parent_type_conflicts(self, by_parent):
765
"""parents must have directory 'contents'."""
767
for parent_id, children in by_parent.iteritems():
768
if parent_id is ROOT_PARENT:
770
if not self._any_contents(children):
772
for child in children:
774
self.final_kind(child)
778
kind = self.final_kind(parent_id)
782
conflicts.append(('missing parent', parent_id))
783
elif kind != "directory":
784
conflicts.append(('non-directory parent', parent_id))
787
def _any_contents(self, trans_ids):
788
"""Return true if any of the trans_ids, will have contents."""
789
for trans_id in trans_ids:
791
kind = self.final_kind(trans_id)
797
def _limbo_name(self, trans_id):
798
"""Generate the limbo name of a file"""
799
limbo_name = self._limbo_files.get(trans_id)
800
if limbo_name is not None:
802
parent = self._new_parent.get(trans_id)
803
# if the parent directory is already in limbo (e.g. when building a
804
# tree), choose a limbo name inside the parent, to reduce further
806
use_direct_path = False
807
if self._new_contents.get(parent) == 'directory':
808
filename = self._new_name.get(trans_id)
809
if filename is not None:
810
if parent not in self._limbo_children:
811
self._limbo_children[parent] = set()
812
self._limbo_children_names[parent] = {}
813
use_direct_path = True
814
# the direct path can only be used if no other file has
815
# already taken this pathname, i.e. if the name is unused, or
816
# if it is already associated with this trans_id.
817
elif self._case_sensitive_target:
818
if (self._limbo_children_names[parent].get(filename)
819
in (trans_id, None)):
820
use_direct_path = True
822
for l_filename, l_trans_id in\
823
self._limbo_children_names[parent].iteritems():
824
if l_trans_id == trans_id:
826
if l_filename.lower() == filename.lower():
829
use_direct_path = True
832
limbo_name = pathjoin(self._limbo_files[parent], filename)
833
self._limbo_children[parent].add(trans_id)
834
self._limbo_children_names[parent][filename] = trans_id
836
limbo_name = pathjoin(self._limbodir, trans_id)
837
self._needs_rename.add(trans_id)
838
self._limbo_files[trans_id] = limbo_name
841
def _set_executability(self, path, entry, trans_id):
842
"""Set the executability of versioned files """
843
new_executability = self._new_executability[trans_id]
844
entry.executable = new_executability
845
if supports_executable():
846
abspath = self._tree.abspath(path)
847
current_mode = os.stat(abspath).st_mode
848
if new_executability:
851
to_mode = current_mode | (0100 & ~umask)
852
# Enable x-bit for others only if they can read it.
853
if current_mode & 0004:
854
to_mode |= 0001 & ~umask
855
if current_mode & 0040:
856
to_mode |= 0010 & ~umask
858
to_mode = current_mode & ~0111
859
os.chmod(abspath, to_mode)
861
def _new_entry(self, name, parent_id, file_id):
862
"""Helper function to create a new filesystem entry."""
863
trans_id = self.create_path(name, parent_id)
864
if file_id is not None:
865
self.version_file(file_id, trans_id)
868
def new_file(self, name, parent_id, contents, file_id=None,
870
"""Convenience method to create files.
872
name is the name of the file to create.
873
parent_id is the transaction id of the parent directory of the file.
874
contents is an iterator of bytestrings, which will be used to produce
876
:param file_id: The inventory ID of the file, if it is to be versioned.
877
:param executable: Only valid when a file_id has been supplied.
879
trans_id = self._new_entry(name, parent_id, file_id)
880
# TODO: rather than scheduling a set_executable call,
881
# have create_file create the file with the right mode.
882
self.create_file(contents, trans_id)
883
if executable is not None:
884
self.set_executability(executable, trans_id)
887
def new_directory(self, name, parent_id, file_id=None):
888
"""Convenience method to create directories.
890
name is the name of the directory to create.
891
parent_id is the transaction id of the parent directory of the
893
file_id is the inventory ID of the directory, if it is to be versioned.
895
trans_id = self._new_entry(name, parent_id, file_id)
896
self.create_directory(trans_id)
899
def new_symlink(self, name, parent_id, target, file_id=None):
900
"""Convenience method to create symbolic link.
902
name is the name of the symlink to create.
903
parent_id is the transaction id of the parent directory of the symlink.
904
target is a bytestring of the target of the symlink.
905
file_id is the inventory ID of the file, if it is to be versioned.
907
trans_id = self._new_entry(name, parent_id, file_id)
908
self.create_symlink(target, trans_id)
911
def _affected_ids(self):
912
"""Return the set of transform ids affected by the transform"""
913
trans_ids = set(self._removed_id)
914
trans_ids.update(self._new_id.keys())
915
trans_ids.update(self._removed_contents)
916
trans_ids.update(self._new_contents.keys())
917
trans_ids.update(self._new_executability.keys())
918
trans_ids.update(self._new_name.keys())
919
trans_ids.update(self._new_parent.keys())
922
def _get_file_id_maps(self):
923
"""Return mapping of file_ids to trans_ids in the to and from states"""
924
trans_ids = self._affected_ids()
927
# Build up two dicts: trans_ids associated with file ids in the
928
# FROM state, vs the TO state.
929
for trans_id in trans_ids:
930
from_file_id = self.tree_file_id(trans_id)
931
if from_file_id is not None:
932
from_trans_ids[from_file_id] = trans_id
933
to_file_id = self.final_file_id(trans_id)
934
if to_file_id is not None:
935
to_trans_ids[to_file_id] = trans_id
936
return from_trans_ids, to_trans_ids
938
def _from_file_data(self, from_trans_id, from_versioned, file_id):
939
"""Get data about a file in the from (tree) state
941
Return a (name, parent, kind, executable) tuple
943
from_path = self._tree_id_paths.get(from_trans_id)
945
# get data from working tree if versioned
946
from_entry = self._tree.inventory[file_id]
947
from_name = from_entry.name
948
from_parent = from_entry.parent_id
951
if from_path is None:
952
# File does not exist in FROM state
956
# File exists, but is not versioned. Have to use path-
958
from_name = os.path.basename(from_path)
959
tree_parent = self.get_tree_parent(from_trans_id)
960
from_parent = self.tree_file_id(tree_parent)
961
if from_path is not None:
962
from_kind, from_executable, from_stats = \
963
self._tree._comparison_data(from_entry, from_path)
966
from_executable = False
967
return from_name, from_parent, from_kind, from_executable
969
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
970
"""Get data about a file in the to (target) state
972
Return a (name, parent, kind, executable) tuple
974
to_name = self.final_name(to_trans_id)
976
to_kind = self.final_kind(to_trans_id)
979
to_parent = self.final_file_id(self.final_parent(to_trans_id))
980
if to_trans_id in self._new_executability:
981
to_executable = self._new_executability[to_trans_id]
982
elif to_trans_id == from_trans_id:
983
to_executable = from_executable
985
to_executable = False
986
return to_name, to_parent, to_kind, to_executable
988
def _iter_changes(self):
989
"""Produce output in the same format as Tree._iter_changes.
991
Will produce nonsensical results if invoked while inventory/filesystem
992
conflicts (as reported by TreeTransform.find_conflicts()) are present.
994
This reads the Transform, but only reproduces changes involving a
995
file_id. Files that are not versioned in either of the FROM or TO
996
states are not reflected.
998
final_paths = FinalPaths(self)
999
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1001
# Now iterate through all active file_ids
1002
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1004
from_trans_id = from_trans_ids.get(file_id)
1005
# find file ids, and determine versioning state
1006
if from_trans_id is None:
1007
from_versioned = False
1008
from_trans_id = to_trans_ids[file_id]
1010
from_versioned = True
1011
to_trans_id = to_trans_ids.get(file_id)
1012
if to_trans_id is None:
1013
to_versioned = False
1014
to_trans_id = from_trans_id
1018
from_name, from_parent, from_kind, from_executable = \
1019
self._from_file_data(from_trans_id, from_versioned, file_id)
1021
to_name, to_parent, to_kind, to_executable = \
1022
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1024
if not from_versioned:
1027
from_path = self._tree_id_paths.get(from_trans_id)
1028
if not to_versioned:
1031
to_path = final_paths.get_path(to_trans_id)
1032
if from_kind != to_kind:
1034
elif to_kind in ('file', 'symlink') and (
1035
to_trans_id != from_trans_id or
1036
to_trans_id in self._new_contents):
1038
if (not modified and from_versioned == to_versioned and
1039
from_parent==to_parent and from_name == to_name and
1040
from_executable == to_executable):
1042
results.append((file_id, (from_path, to_path), modified,
1043
(from_versioned, to_versioned),
1044
(from_parent, to_parent),
1045
(from_name, to_name),
1046
(from_kind, to_kind),
1047
(from_executable, to_executable)))
1048
return iter(sorted(results, key=lambda x:x[1]))
1050
def get_preview_tree(self):
1051
"""Return a tree representing the result of the transform.
1053
This tree only supports the subset of Tree functionality required
1054
by show_diff_trees. It must only be compared to tt._tree.
1056
return _PreviewTree(self)
1059
class TreeTransform(TreeTransformBase):
1060
"""Represent a tree transformation.
1062
This object is designed to support incremental generation of the transform,
1065
However, it gives optimum performance when parent directories are created
1066
before their contents. The transform is then able to put child files
1067
directly in their parent directory, avoiding later renames.
1069
It is easy to produce malformed transforms, but they are generally
1070
harmless. Attempting to apply a malformed transform will cause an
1071
exception to be raised before any modifications are made to the tree.
1073
Many kinds of malformed transforms can be corrected with the
1074
resolve_conflicts function. The remaining ones indicate programming error,
1075
such as trying to create a file with no path.
1077
Two sets of file creation methods are supplied. Convenience methods are:
1082
These are composed of the low-level methods:
1084
* create_file or create_directory or create_symlink
1088
Transform/Transaction ids
1089
-------------------------
1090
trans_ids are temporary ids assigned to all files involved in a transform.
1091
It's possible, even common, that not all files in the Tree have trans_ids.
1093
trans_ids are used because filenames and file_ids are not good enough
1094
identifiers; filenames change, and not all files have file_ids. File-ids
1095
are also associated with trans-ids, so that moving a file moves its
1098
trans_ids are only valid for the TreeTransform that generated them.
1102
Limbo is a temporary directory use to hold new versions of files.
1103
Files are added to limbo by create_file, create_directory, create_symlink,
1104
and their convenience variants (new_*). Files may be removed from limbo
1105
using cancel_creation. Files are renamed from limbo into their final
1106
location as part of TreeTransform.apply
1108
Limbo must be cleaned up, by either calling TreeTransform.apply or
1109
calling TreeTransform.finalize.
1111
Files are placed into limbo inside their parent directories, where
1112
possible. This reduces subsequent renames, and makes operations involving
1113
lots of files faster. This optimization is only possible if the parent
1114
directory is created *before* creating any of its children, so avoid
1115
creating children before parents, where possible.
1119
This temporary directory is used by _FileMover for storing files that are
1120
about to be deleted. In case of rollback, the files will be restored.
1121
FileMover does not delete files until it is sure that a rollback will not
1124
def __init__(self, tree, pb=DummyProgress()):
1125
"""Note: a tree_write lock is taken on the tree.
1127
Use TreeTransform.finalize() to release the lock (can be omitted if
1128
TreeTransform.apply() called).
1130
tree.lock_tree_write()
1133
control_files = tree._control_files
1134
limbodir = urlutils.local_path_from_url(
1135
control_files.controlfilename('limbo'))
1139
if e.errno == errno.EEXIST:
1140
raise ExistingLimbo(limbodir)
1141
deletiondir = urlutils.local_path_from_url(
1142
control_files.controlfilename('pending-deletion'))
1144
os.mkdir(deletiondir)
1146
if e.errno == errno.EEXIST:
1147
raise errors.ExistingPendingDeletion(deletiondir)
1152
TreeTransformBase.__init__(self, tree, limbodir, pb,
1153
tree.case_sensitive)
1154
self._deletiondir = deletiondir
1156
def apply(self, no_conflicts=False, _mover=None):
1157
"""Apply all changes to the inventory and filesystem.
1159
If filesystem or inventory conflicts are present, MalformedTransform
1162
If apply succeeds, finalize is not necessary.
1164
:param no_conflicts: if True, the caller guarantees there are no
1165
conflicts, so no check is made.
1166
:param _mover: Supply an alternate FileMover, for testing
1168
if not no_conflicts:
1169
conflicts = self.find_conflicts()
1170
if len(conflicts) != 0:
1171
raise MalformedTransform(conflicts=conflicts)
1172
inv = self._tree.inventory
1173
inventory_delta = []
1174
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1177
mover = _FileMover()
1181
child_pb.update('Apply phase', 0, 2)
1182
self._apply_removals(inv, inventory_delta, mover)
1183
child_pb.update('Apply phase', 1, 2)
1184
modified_paths = self._apply_insertions(inv, inventory_delta,
1190
mover.apply_deletions()
1193
self._tree.apply_inventory_delta(inventory_delta)
1196
return _TransformResults(modified_paths, self.rename_count)
1198
def _apply_removals(self, inv, inventory_delta, mover):
1199
"""Perform tree operations that remove directory/inventory names.
1201
That is, delete files that are to be deleted, and put any files that
1202
need renaming into limbo. This must be done in strict child-to-parent
1205
tree_paths = list(self._tree_path_ids.iteritems())
1206
tree_paths.sort(reverse=True)
1207
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1209
for num, data in enumerate(tree_paths):
1210
path, trans_id = data
1211
child_pb.update('removing file', num, len(tree_paths))
1212
full_path = self._tree.abspath(path)
1213
if trans_id in self._removed_contents:
1214
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1216
elif trans_id in self._new_name or trans_id in \
1219
mover.rename(full_path, self._limbo_name(trans_id))
1221
if e.errno != errno.ENOENT:
1224
self.rename_count += 1
1225
if trans_id in self._removed_id:
1226
if trans_id == self._new_root:
1227
file_id = self._tree.get_root_id()
1229
file_id = self.tree_file_id(trans_id)
1230
if file_id is not None:
1231
inventory_delta.append((path, None, file_id, None))
1235
def _apply_insertions(self, inv, inventory_delta, mover):
1236
"""Perform tree operations that insert directory/inventory names.
1238
That is, create any files that need to be created, and restore from
1239
limbo any files that needed renaming. This must be done in strict
1240
parent-to-child order.
1242
new_paths = self.new_paths()
1244
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1247
for num, (path, trans_id) in enumerate(new_paths):
1249
child_pb.update('adding file', num, len(new_paths))
1251
kind = self._new_contents[trans_id]
1253
kind = contents = None
1254
if trans_id in self._new_contents or \
1255
self.path_changed(trans_id):
1256
full_path = self._tree.abspath(path)
1257
if trans_id in self._needs_rename:
1259
mover.rename(self._limbo_name(trans_id), full_path)
1261
# We may be renaming a dangling inventory id
1262
if e.errno != errno.ENOENT:
1265
self.rename_count += 1
1266
if trans_id in self._new_contents:
1267
modified_paths.append(full_path)
1268
completed_new.append(trans_id)
1270
if trans_id in self._new_id:
1272
kind = file_kind(self._tree.abspath(path))
1273
if trans_id in self._new_reference_revision:
1274
new_entry = inventory.TreeReference(
1275
self._new_id[trans_id],
1276
self._new_name[trans_id],
1277
self.final_file_id(self._new_parent[trans_id]),
1278
None, self._new_reference_revision[trans_id])
1280
new_entry = inventory.make_entry(kind,
1281
self.final_name(trans_id),
1282
self.final_file_id(self.final_parent(trans_id)),
1283
self._new_id[trans_id])
1285
if trans_id in self._new_name or trans_id in\
1286
self._new_parent or\
1287
trans_id in self._new_executability:
1288
file_id = self.final_file_id(trans_id)
1289
if file_id is not None:
1290
entry = inv[file_id]
1291
new_entry = entry.copy()
1293
if trans_id in self._new_name or trans_id in\
1295
if new_entry is not None:
1296
new_entry.name = self.final_name(trans_id)
1297
parent = self.final_parent(trans_id)
1298
parent_id = self.final_file_id(parent)
1299
new_entry.parent_id = parent_id
1301
if trans_id in self._new_executability:
1302
self._set_executability(path, new_entry, trans_id)
1303
if new_entry is not None:
1304
if new_entry.file_id in inv:
1305
old_path = inv.id2path(new_entry.file_id)
1308
inventory_delta.append((old_path, path,
1313
for trans_id in completed_new:
1314
del self._new_contents[trans_id]
1315
return modified_paths
1318
class TransformPreview(TreeTransformBase):
1319
"""A TreeTransform for generating preview trees.
1321
Unlike TreeTransform, this version works when the input tree is a
1322
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1323
unversioned files in the input tree.
1326
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1328
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1329
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1331
def canonical_path(self, path):
1334
def tree_kind(self, trans_id):
1335
path = self._tree_id_paths.get(trans_id)
1337
raise NoSuchFile(None)
1338
file_id = self._tree.path2id(path)
1339
return self._tree.kind(file_id)
1341
def _set_mode(self, trans_id, mode_id, typefunc):
1342
"""Set the mode of new file contents.
1343
The mode_id is the existing file to get the mode from (often the same
1344
as trans_id). The operation is only performed if there's a mode match
1345
according to typefunc.
1347
# is it ok to ignore this? probably
1350
def iter_tree_children(self, parent_id):
1351
"""Iterate through the entry's tree children, if any"""
1353
path = self._tree_id_paths[parent_id]
1356
file_id = self.tree_file_id(parent_id)
1357
for child in self._tree.inventory[file_id].children.iterkeys():
1358
childpath = joinpath(path, child)
1359
yield self.trans_id_tree_path(childpath)
1362
class _PreviewTree(object):
1363
"""Partial implementation of Tree to support show_diff_trees"""
1365
def __init__(self, transform):
1366
self._transform = transform
1368
def lock_read(self):
1369
# Perhaps in theory, this should lock the TreeTransform?
1375
def _iter_changes(self, from_tree, include_unchanged=False,
1376
specific_files=None, pb=None, extra_trees=None,
1377
require_versioned=True, want_unversioned=False):
1378
"""See InterTree._iter_changes.
1380
This implementation does not support include_unchanged, specific_files,
1381
or want_unversioned. extra_trees, require_versioned, and pb are
1384
if from_tree is not self._transform._tree:
1385
raise ValueError('from_tree must be transform source tree.')
1386
if include_unchanged:
1387
raise ValueError('include_unchanged is not supported')
1388
if specific_files is not None:
1389
raise ValueError('specific_files is not supported')
1390
if want_unversioned:
1391
raise ValueError('want_unversioned is not supported')
1392
return self._transform._iter_changes()
1394
def kind(self, file_id):
1395
trans_id = self._transform.trans_id_file_id(file_id)
1396
return self._transform.final_kind(trans_id)
1398
def get_file_mtime(self, file_id, path=None):
1399
"""See Tree.get_file_mtime"""
1400
trans_id = self._transform.trans_id_file_id(file_id)
1401
name = self._transform._limbo_name(trans_id)
1402
return os.stat(name).st_mtime
1404
def get_file(self, file_id):
1405
"""See Tree.get_file"""
1406
trans_id = self._transform.trans_id_file_id(file_id)
1407
name = self._transform._limbo_name(trans_id)
1408
return open(name, 'rb')
1410
def get_symlink_target(self, file_id):
1411
"""See Tree.get_symlink_target"""
1412
trans_id = self._transform.trans_id_file_id(file_id)
1413
name = self._transform._limbo_name(trans_id)
1414
return os.readlink(name)
1416
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1417
"""See Tree.paths2ids"""
1421
def joinpath(parent, child):
1422
"""Join tree-relative paths, handling the tree root specially"""
1423
if parent is None or parent == "":
1426
return pathjoin(parent, child)
1429
class FinalPaths(object):
1430
"""Make path calculation cheap by memoizing paths.
1432
The underlying tree must not be manipulated between calls, or else
1433
the results will likely be incorrect.
1435
def __init__(self, transform):
1436
object.__init__(self)
1437
self._known_paths = {}
1438
self.transform = transform
1440
def _determine_path(self, trans_id):
1441
if trans_id == self.transform.root:
1443
name = self.transform.final_name(trans_id)
1444
parent_id = self.transform.final_parent(trans_id)
1445
if parent_id == self.transform.root:
1448
return pathjoin(self.get_path(parent_id), name)
1450
def get_path(self, trans_id):
1451
"""Find the final path associated with a trans_id"""
1452
if trans_id not in self._known_paths:
1453
self._known_paths[trans_id] = self._determine_path(trans_id)
1454
return self._known_paths[trans_id]
1457
def topology_sorted_ids(tree):
1458
"""Determine the topological order of the ids in a tree"""
1459
file_ids = list(tree)
1460
file_ids.sort(key=tree.id2path)
1464
def build_tree(tree, wt, accelerator_tree=None):
1465
"""Create working tree for a branch, using a TreeTransform.
1467
This function should be used on empty trees, having a tree root at most.
1468
(see merge and revert functionality for working with existing trees)
1470
Existing files are handled like so:
1472
- Existing bzrdirs take precedence over creating new items. They are
1473
created as '%s.diverted' % name.
1474
- Otherwise, if the content on disk matches the content we are building,
1475
it is silently replaced.
1476
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1478
:param tree: The tree to convert wt into a copy of
1479
:param wt: The working tree that files will be placed into
1480
:param accelerator_tree: A tree which can be used for retrieving file
1481
contents more quickly than tree itself, i.e. a workingtree. tree
1482
will be used for cases where accelerator_tree's content is different.
1484
wt.lock_tree_write()
1488
if accelerator_tree is not None:
1489
accelerator_tree.lock_read()
1491
return _build_tree(tree, wt, accelerator_tree)
1493
if accelerator_tree is not None:
1494
accelerator_tree.unlock()
1501
def _build_tree(tree, wt, accelerator_tree):
1502
"""See build_tree."""
1503
if len(wt.inventory) > 1: # more than just a root
1504
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1506
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1507
pp = ProgressPhase("Build phase", 2, top_pb)
1508
if tree.inventory.root is not None:
1509
# This is kind of a hack: we should be altering the root
1510
# as part of the regular tree shape diff logic.
1511
# The conditional test here is to avoid doing an
1512
# expensive operation (flush) every time the root id
1513
# is set within the tree, nor setting the root and thus
1514
# marking the tree as dirty, because we use two different
1515
# idioms here: tree interfaces and inventory interfaces.
1516
if wt.get_root_id() != tree.get_root_id():
1517
wt.set_root_id(tree.get_root_id())
1519
tt = TreeTransform(wt)
1523
file_trans_id[wt.get_root_id()] = \
1524
tt.trans_id_tree_file_id(wt.get_root_id())
1525
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1527
deferred_contents = []
1528
for num, (tree_path, entry) in \
1529
enumerate(tree.inventory.iter_entries_by_dir()):
1530
pb.update("Building tree", num - len(deferred_contents),
1531
len(tree.inventory))
1532
if entry.parent_id is None:
1535
file_id = entry.file_id
1536
target_path = wt.abspath(tree_path)
1538
kind = file_kind(target_path)
1542
if kind == "directory":
1544
bzrdir.BzrDir.open(target_path)
1545
except errors.NotBranchError:
1549
if (file_id not in divert and
1550
_content_match(tree, entry, file_id, kind,
1552
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1553
if kind == 'directory':
1555
if entry.parent_id not in file_trans_id:
1556
raise AssertionError(
1557
'entry %s parent id %r is not in file_trans_id %r'
1558
% (entry, entry.parent_id, file_trans_id))
1559
parent_id = file_trans_id[entry.parent_id]
1560
if entry.kind == 'file':
1561
# We *almost* replicate new_by_entry, so that we can defer
1562
# getting the file text, and get them all at once.
1563
trans_id = tt.create_path(entry.name, parent_id)
1564
file_trans_id[file_id] = trans_id
1565
tt.version_file(entry.file_id, trans_id)
1566
executable = tree.is_executable(entry.file_id, tree_path)
1567
if executable is not None:
1568
tt.set_executability(executable, trans_id)
1569
deferred_contents.append((entry.file_id, trans_id))
1571
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1574
new_trans_id = file_trans_id[file_id]
1575
old_parent = tt.trans_id_tree_path(tree_path)
1576
_reparent_children(tt, old_parent, new_trans_id)
1577
for num, (trans_id, bytes) in enumerate(
1578
_iter_files_bytes_accelerated(tree, accelerator_tree,
1579
deferred_contents)):
1580
tt.create_file(bytes, trans_id)
1581
pb.update('Adding file contents',
1582
(num + len(tree.inventory) - len(deferred_contents)),
1583
len(tree.inventory))
1587
divert_trans = set(file_trans_id[f] for f in divert)
1588
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1589
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1590
conflicts = cook_conflicts(raw_conflicts, tt)
1591
for conflict in conflicts:
1594
wt.add_conflicts(conflicts)
1595
except errors.UnsupportedOperation:
1597
result = tt.apply(no_conflicts=True)
1604
def _iter_files_bytes_accelerated(tree, accelerator_tree, desired_files):
1605
if accelerator_tree is None:
1606
new_desired_files = desired_files
1608
iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
1609
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1611
new_desired_files = []
1612
for file_id, identifier in desired_files:
1613
accelerator_path = unchanged.get(file_id)
1614
if accelerator_path is None:
1615
new_desired_files.append((file_id, identifier))
1617
contents = accelerator_tree.get_file(file_id, accelerator_path)
1620
contents_bytes = (contents.read(),)
1623
yield identifier, contents_bytes
1624
for result in tree.iter_files_bytes(new_desired_files):
1628
def _reparent_children(tt, old_parent, new_parent):
1629
for child in tt.iter_tree_children(old_parent):
1630
tt.adjust_path(tt.final_name(child), new_parent, child)
1632
def _reparent_transform_children(tt, old_parent, new_parent):
1633
by_parent = tt.by_parent()
1634
for child in by_parent[old_parent]:
1635
tt.adjust_path(tt.final_name(child), new_parent, child)
1637
def _content_match(tree, entry, file_id, kind, target_path):
1638
if entry.kind != kind:
1640
if entry.kind == "directory":
1642
if entry.kind == "file":
1643
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1645
elif entry.kind == "symlink":
1646
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1651
def resolve_checkout(tt, conflicts, divert):
1652
new_conflicts = set()
1653
for c_type, conflict in ((c[0], c) for c in conflicts):
1654
# Anything but a 'duplicate' would indicate programmer error
1655
assert c_type == 'duplicate', c_type
1656
# Now figure out which is new and which is old
1657
if tt.new_contents(conflict[1]):
1658
new_file = conflict[1]
1659
old_file = conflict[2]
1661
new_file = conflict[2]
1662
old_file = conflict[1]
1664
# We should only get here if the conflict wasn't completely
1666
final_parent = tt.final_parent(old_file)
1667
if new_file in divert:
1668
new_name = tt.final_name(old_file)+'.diverted'
1669
tt.adjust_path(new_name, final_parent, new_file)
1670
new_conflicts.add((c_type, 'Diverted to',
1671
new_file, old_file))
1673
new_name = tt.final_name(old_file)+'.moved'
1674
tt.adjust_path(new_name, final_parent, old_file)
1675
new_conflicts.add((c_type, 'Moved existing file to',
1676
old_file, new_file))
1677
return new_conflicts
1680
def new_by_entry(tt, entry, parent_id, tree):
1681
"""Create a new file according to its inventory entry"""
1685
contents = tree.get_file(entry.file_id).readlines()
1686
executable = tree.is_executable(entry.file_id)
1687
return tt.new_file(name, parent_id, contents, entry.file_id,
1689
elif kind in ('directory', 'tree-reference'):
1690
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1691
if kind == 'tree-reference':
1692
tt.set_tree_reference(entry.reference_revision, trans_id)
1694
elif kind == 'symlink':
1695
target = tree.get_symlink_target(entry.file_id)
1696
return tt.new_symlink(name, parent_id, target, entry.file_id)
1698
raise errors.BadFileKindError(name, kind)
1701
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1702
"""Create new file contents according to an inventory entry."""
1703
if entry.kind == "file":
1705
lines = tree.get_file(entry.file_id).readlines()
1706
tt.create_file(lines, trans_id, mode_id=mode_id)
1707
elif entry.kind == "symlink":
1708
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1709
elif entry.kind == "directory":
1710
tt.create_directory(trans_id)
1713
def create_entry_executability(tt, entry, trans_id):
1714
"""Set the executability of a trans_id according to an inventory entry"""
1715
if entry.kind == "file":
1716
tt.set_executability(entry.executable, trans_id)
1719
@deprecated_function(zero_fifteen)
1720
def find_interesting(working_tree, target_tree, filenames):
1721
"""Find the ids corresponding to specified filenames.
1723
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1725
working_tree.lock_read()
1727
target_tree.lock_read()
1729
return working_tree.paths2ids(filenames, [target_tree])
1731
target_tree.unlock()
1733
working_tree.unlock()
1736
@deprecated_function(zero_ninety)
1737
def change_entry(tt, file_id, working_tree, target_tree,
1738
trans_id_file_id, backups, trans_id, by_parent):
1739
"""Replace a file_id's contents with those from a target tree."""
1740
if file_id is None and target_tree is None:
1741
# skip the logic altogether in the deprecation test
1743
e_trans_id = trans_id_file_id(file_id)
1744
entry = target_tree.inventory[file_id]
1745
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1748
mode_id = e_trans_id
1751
tt.delete_contents(e_trans_id)
1753
parent_trans_id = trans_id_file_id(entry.parent_id)
1754
backup_name = get_backup_name(entry, by_parent,
1755
parent_trans_id, tt)
1756
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1757
tt.unversion_file(e_trans_id)
1758
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1759
tt.version_file(file_id, e_trans_id)
1760
trans_id[file_id] = e_trans_id
1761
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1762
create_entry_executability(tt, entry, e_trans_id)
1765
tt.set_executability(entry.executable, e_trans_id)
1766
if tt.final_name(e_trans_id) != entry.name:
1769
parent_id = tt.final_parent(e_trans_id)
1770
parent_file_id = tt.final_file_id(parent_id)
1771
if parent_file_id != entry.parent_id:
1776
parent_trans_id = trans_id_file_id(entry.parent_id)
1777
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1780
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1781
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1784
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1785
"""Produce a backup-style name that appears to be available"""
1789
yield "%s.~%d~" % (name, counter)
1791
for new_name in name_gen():
1792
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1796
def _entry_changes(file_id, entry, working_tree):
1797
"""Determine in which ways the inventory entry has changed.
1799
Returns booleans: has_contents, content_mod, meta_mod
1800
has_contents means there are currently contents, but they differ
1801
contents_mod means contents need to be modified
1802
meta_mod means the metadata needs to be modified
1804
cur_entry = working_tree.inventory[file_id]
1806
working_kind = working_tree.kind(file_id)
1809
has_contents = False
1812
if has_contents is True:
1813
if entry.kind != working_kind:
1814
contents_mod, meta_mod = True, False
1816
cur_entry._read_tree_state(working_tree.id2path(file_id),
1818
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1819
cur_entry._forget_tree_state()
1820
return has_contents, contents_mod, meta_mod
1823
def revert(working_tree, target_tree, filenames, backups=False,
1824
pb=DummyProgress(), change_reporter=None):
1825
"""Revert a working tree's contents to those of a target tree."""
1826
target_tree.lock_read()
1827
tt = TreeTransform(working_tree, pb)
1829
pp = ProgressPhase("Revert phase", 3, pb)
1831
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1833
merge_modified = _alter_files(working_tree, target_tree, tt,
1834
child_pb, filenames, backups)
1838
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1840
raw_conflicts = resolve_conflicts(tt, child_pb,
1841
lambda t, c: conflict_pass(t, c, target_tree))
1844
conflicts = cook_conflicts(raw_conflicts, tt)
1846
change_reporter = delta._ChangeReporter(
1847
unversioned_filter=working_tree.is_ignored)
1848
delta.report_changes(tt._iter_changes(), change_reporter)
1849
for conflict in conflicts:
1853
working_tree.set_merge_modified(merge_modified)
1855
target_tree.unlock()
1861
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1863
merge_modified = working_tree.merge_modified()
1864
change_list = target_tree._iter_changes(working_tree,
1865
specific_files=specific_files, pb=pb)
1866
if target_tree.inventory.root is None:
1873
for id_num, (file_id, path, changed_content, versioned, parent, name,
1874
kind, executable) in enumerate(change_list):
1875
if skip_root and file_id[0] is not None and parent[0] is None:
1877
trans_id = tt.trans_id_file_id(file_id)
1880
keep_content = False
1881
if kind[0] == 'file' and (backups or kind[1] is None):
1882
wt_sha1 = working_tree.get_file_sha1(file_id)
1883
if merge_modified.get(file_id) != wt_sha1:
1884
# acquire the basis tree lazily to prevent the
1885
# expense of accessing it when it's not needed ?
1886
# (Guessing, RBC, 200702)
1887
if basis_tree is None:
1888
basis_tree = working_tree.basis_tree()
1889
basis_tree.lock_read()
1890
if file_id in basis_tree:
1891
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1893
elif kind[1] is None and not versioned[1]:
1895
if kind[0] is not None:
1896
if not keep_content:
1897
tt.delete_contents(trans_id)
1898
elif kind[1] is not None:
1899
parent_trans_id = tt.trans_id_file_id(parent[0])
1900
by_parent = tt.by_parent()
1901
backup_name = _get_backup_name(name[0], by_parent,
1902
parent_trans_id, tt)
1903
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1904
new_trans_id = tt.create_path(name[0], parent_trans_id)
1905
if versioned == (True, True):
1906
tt.unversion_file(trans_id)
1907
tt.version_file(file_id, new_trans_id)
1908
# New contents should have the same unix perms as old
1911
trans_id = new_trans_id
1912
if kind[1] == 'directory':
1913
tt.create_directory(trans_id)
1914
elif kind[1] == 'symlink':
1915
tt.create_symlink(target_tree.get_symlink_target(file_id),
1917
elif kind[1] == 'file':
1918
deferred_files.append((file_id, (trans_id, mode_id)))
1919
if basis_tree is None:
1920
basis_tree = working_tree.basis_tree()
1921
basis_tree.lock_read()
1922
new_sha1 = target_tree.get_file_sha1(file_id)
1923
if (file_id in basis_tree and new_sha1 ==
1924
basis_tree.get_file_sha1(file_id)):
1925
if file_id in merge_modified:
1926
del merge_modified[file_id]
1928
merge_modified[file_id] = new_sha1
1930
# preserve the execute bit when backing up
1931
if keep_content and executable[0] == executable[1]:
1932
tt.set_executability(executable[1], trans_id)
1934
assert kind[1] is None
1935
if versioned == (False, True):
1936
tt.version_file(file_id, trans_id)
1937
if versioned == (True, False):
1938
tt.unversion_file(trans_id)
1939
if (name[1] is not None and
1940
(name[0] != name[1] or parent[0] != parent[1])):
1942
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1943
if executable[0] != executable[1] and kind[1] == "file":
1944
tt.set_executability(executable[1], trans_id)
1945
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1947
tt.create_file(bytes, trans_id, mode_id)
1949
if basis_tree is not None:
1951
return merge_modified
1954
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1955
"""Make many conflict-resolution attempts, but die if they fail"""
1956
if pass_func is None:
1957
pass_func = conflict_pass
1958
new_conflicts = set()
1961
pb.update('Resolution pass', n+1, 10)
1962
conflicts = tt.find_conflicts()
1963
if len(conflicts) == 0:
1964
return new_conflicts
1965
new_conflicts.update(pass_func(tt, conflicts))
1966
raise MalformedTransform(conflicts=conflicts)
1971
def conflict_pass(tt, conflicts, path_tree=None):
1972
"""Resolve some classes of conflicts.
1974
:param tt: The transform to resolve conflicts in
1975
:param conflicts: The conflicts to resolve
1976
:param path_tree: A Tree to get supplemental paths from
1978
new_conflicts = set()
1979
for c_type, conflict in ((c[0], c) for c in conflicts):
1980
if c_type == 'duplicate id':
1981
tt.unversion_file(conflict[1])
1982
new_conflicts.add((c_type, 'Unversioned existing file',
1983
conflict[1], conflict[2], ))
1984
elif c_type == 'duplicate':
1985
# files that were renamed take precedence
1986
final_parent = tt.final_parent(conflict[1])
1987
if tt.path_changed(conflict[1]):
1988
existing_file, new_file = conflict[2], conflict[1]
1990
existing_file, new_file = conflict[1], conflict[2]
1991
new_name = tt.final_name(existing_file)+'.moved'
1992
tt.adjust_path(new_name, final_parent, existing_file)
1993
new_conflicts.add((c_type, 'Moved existing file to',
1994
existing_file, new_file))
1995
elif c_type == 'parent loop':
1996
# break the loop by undoing one of the ops that caused the loop
1998
while not tt.path_changed(cur):
1999
cur = tt.final_parent(cur)
2000
new_conflicts.add((c_type, 'Cancelled move', cur,
2001
tt.final_parent(cur),))
2002
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2004
elif c_type == 'missing parent':
2005
trans_id = conflict[1]
2007
tt.cancel_deletion(trans_id)
2008
new_conflicts.add(('deleting parent', 'Not deleting',
2011
tt.create_directory(trans_id)
2012
new_conflicts.add((c_type, 'Created directory', trans_id))
2014
tt.final_name(trans_id)
2016
if path_tree is not None:
2017
file_id = tt.final_file_id(trans_id)
2018
entry = path_tree.inventory[file_id]
2019
parent_trans_id = tt.trans_id_file_id(entry.parent_id)
2020
tt.adjust_path(entry.name, parent_trans_id, trans_id)
2021
elif c_type == 'unversioned parent':
2022
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
2023
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2024
elif c_type == 'non-directory parent':
2025
parent_id = conflict[1]
2026
parent_parent = tt.final_parent(parent_id)
2027
parent_name = tt.final_name(parent_id)
2028
parent_file_id = tt.final_file_id(parent_id)
2029
new_parent_id = tt.new_directory(parent_name + '.new',
2030
parent_parent, parent_file_id)
2031
_reparent_transform_children(tt, parent_id, new_parent_id)
2032
tt.unversion_file(parent_id)
2033
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2034
return new_conflicts
2037
def cook_conflicts(raw_conflicts, tt):
2038
"""Generate a list of cooked conflicts, sorted by file path"""
2039
from bzrlib.conflicts import Conflict
2040
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2041
return sorted(conflict_iter, key=Conflict.sort_key)
2044
def iter_cook_conflicts(raw_conflicts, tt):
2045
from bzrlib.conflicts import Conflict
2047
for conflict in raw_conflicts:
2048
c_type = conflict[0]
2049
action = conflict[1]
2050
modified_path = fp.get_path(conflict[2])
2051
modified_id = tt.final_file_id(conflict[2])
2052
if len(conflict) == 3:
2053
yield Conflict.factory(c_type, action=action, path=modified_path,
2054
file_id=modified_id)
2057
conflicting_path = fp.get_path(conflict[3])
2058
conflicting_id = tt.final_file_id(conflict[3])
2059
yield Conflict.factory(c_type, action=action, path=modified_path,
2060
file_id=modified_id,
2061
conflict_path=conflicting_path,
2062
conflict_file_id=conflicting_id)
2065
class _FileMover(object):
2066
"""Moves and deletes files for TreeTransform, tracking operations"""
2069
self.past_renames = []
2070
self.pending_deletions = []
2072
def rename(self, from_, to):
2073
"""Rename a file from one path to another. Functions like os.rename"""
2075
os.rename(from_, to)
2077
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2078
raise errors.FileExists(to, str(e))
2080
self.past_renames.append((from_, to))
2082
def pre_delete(self, from_, to):
2083
"""Rename a file out of the way and mark it for deletion.
2085
Unlike os.unlink, this works equally well for files and directories.
2086
:param from_: The current file path
2087
:param to: A temporary path for the file
2089
self.rename(from_, to)
2090
self.pending_deletions.append(to)
2093
"""Reverse all renames that have been performed"""
2094
for from_, to in reversed(self.past_renames):
2095
os.rename(to, from_)
2096
# after rollback, don't reuse _FileMover
2098
pending_deletions = None
2100
def apply_deletions(self):
2101
"""Apply all marked deletions"""
2102
for path in self.pending_deletions:
2104
# after apply_deletions, don't reuse _FileMover
2106
pending_deletions = None
added
removed
bzrlib/transform.py
