~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/mutabletree.py

merge merge tweaks from aaron, which includes latest .dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""MutableTree object.
18
 
 
19
 
See MutableTree for more details.
20
 
"""
21
 
 
22
 
from __future__ import absolute_import
23
 
 
24
 
from bzrlib.lazy_import import lazy_import
25
 
lazy_import(globals(), """
26
 
import operator
27
 
import os
28
 
import re
29
 
 
30
 
from bzrlib import (
31
 
    add,
32
 
    controldir,
33
 
    errors,
34
 
    hooks,
35
 
    inventory as _mod_inventory,
36
 
    osutils,
37
 
    revisiontree,
38
 
    trace,
39
 
    transport as _mod_transport,
40
 
    tree,
41
 
    )
42
 
""")
43
 
 
44
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
45
 
 
46
 
 
47
 
def needs_tree_write_lock(unbound):
48
 
    """Decorate unbound to take out and release a tree_write lock."""
49
 
    def tree_write_locked(self, *args, **kwargs):
50
 
        self.lock_tree_write()
51
 
        try:
52
 
            return unbound(self, *args, **kwargs)
53
 
        finally:
54
 
            self.unlock()
55
 
    tree_write_locked.__doc__ = unbound.__doc__
56
 
    tree_write_locked.__name__ = unbound.__name__
57
 
    return tree_write_locked
58
 
 
59
 
 
60
 
class MutableTree(tree.Tree):
61
 
    """A MutableTree is a specialisation of Tree which is able to be mutated.
62
 
 
63
 
    Generally speaking these mutations are only possible within a lock_write
64
 
    context, and will revert if the lock is broken abnormally - but this cannot
65
 
    be guaranteed - depending on the exact implementation of the mutable state.
66
 
 
67
 
    The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
68
 
    For tests we also have MemoryTree which is a MutableTree whose contents are
69
 
    entirely in memory.
70
 
 
71
 
    For now, we are not treating MutableTree as an interface to provide
72
 
    conformance tests for - rather we are testing MemoryTree specifically, and
73
 
    interface testing implementations of WorkingTree.
74
 
 
75
 
    A mutable tree always has an associated Branch and ControlDir object - the
76
 
    branch and bzrdir attributes.
77
 
    """
78
 
    def __init__(self, *args, **kw):
79
 
        super(MutableTree, self).__init__(*args, **kw)
80
 
        # Is this tree on a case-insensitive or case-preserving file-system?
81
 
        # Sub-classes may initialize to False if they detect they are being
82
 
        # used on media which doesn't differentiate the case of names.
83
 
        self.case_sensitive = True
84
 
 
85
 
    def is_control_filename(self, filename):
86
 
        """True if filename is the name of a control file in this tree.
87
 
 
88
 
        :param filename: A filename within the tree. This is a relative path
89
 
            from the root of this tree.
90
 
 
91
 
        This is true IF and ONLY IF the filename is part of the meta data
92
 
        that bzr controls in this tree. I.E. a random .bzr directory placed
93
 
        on disk will not be a control file for this tree.
94
 
        """
95
 
        raise NotImplementedError(self.is_control_filename)
96
 
 
97
 
    @needs_tree_write_lock
98
 
    def add(self, files, ids=None, kinds=None):
99
 
        """Add paths to the set of versioned paths.
100
 
 
101
 
        Note that the command line normally calls smart_add instead,
102
 
        which can automatically recurse.
103
 
 
104
 
        This adds the files to the inventory, so that they will be
105
 
        recorded by the next commit.
106
 
 
107
 
        :param files: List of paths to add, relative to the base of the tree.
108
 
        :param ids: If set, use these instead of automatically generated ids.
109
 
            Must be the same length as the list of files, but may
110
 
            contain None for ids that are to be autogenerated.
111
 
        :param kinds: Optional parameter to specify the kinds to be used for
112
 
            each file.
113
 
 
114
 
        TODO: Perhaps callback with the ids and paths as they're added.
115
 
        """
116
 
        if isinstance(files, basestring):
117
 
            # XXX: Passing a single string is inconsistent and should be
118
 
            # deprecated.
119
 
            if not (ids is None or isinstance(ids, basestring)):
120
 
                raise AssertionError()
121
 
            if not (kinds is None or isinstance(kinds, basestring)):
122
 
                raise AssertionError()
123
 
            files = [files]
124
 
            if ids is not None:
125
 
                ids = [ids]
126
 
            if kinds is not None:
127
 
                kinds = [kinds]
128
 
 
129
 
        files = [path.strip('/') for path in files]
130
 
 
131
 
        if ids is None:
132
 
            ids = [None] * len(files)
133
 
        else:
134
 
            if not (len(ids) == len(files)):
135
 
                raise AssertionError()
136
 
        if kinds is None:
137
 
            kinds = [None] * len(files)
138
 
        elif not len(kinds) == len(files):
139
 
            raise AssertionError()
140
 
        for f in files:
141
 
            # generic constraint checks:
142
 
            if self.is_control_filename(f):
143
 
                raise errors.ForbiddenControlFileError(filename=f)
144
 
            fp = osutils.splitpath(f)
145
 
        # fill out file kinds for all files [not needed when we stop
146
 
        # caring about the instantaneous file kind within a uncommmitted tree
147
 
        #
148
 
        self._gather_kinds(files, kinds)
149
 
        self._add(files, ids, kinds)
150
 
 
151
 
    def add_reference(self, sub_tree):
152
 
        """Add a TreeReference to the tree, pointing at sub_tree"""
153
 
        raise errors.UnsupportedOperation(self.add_reference, self)
154
 
 
155
 
    def _add_reference(self, sub_tree):
156
 
        """Standard add_reference implementation, for use by subclasses"""
157
 
        try:
158
 
            sub_tree_path = self.relpath(sub_tree.basedir)
159
 
        except errors.PathNotChild:
160
 
            raise errors.BadReferenceTarget(self, sub_tree,
161
 
                                            'Target not inside tree.')
162
 
        sub_tree_id = sub_tree.get_root_id()
163
 
        if sub_tree_id == self.get_root_id():
164
 
            raise errors.BadReferenceTarget(self, sub_tree,
165
 
                                     'Trees have the same root id.')
166
 
        if self.has_id(sub_tree_id):
167
 
            raise errors.BadReferenceTarget(self, sub_tree,
168
 
                                            'Root id already present in tree')
169
 
        self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
170
 
 
171
 
    def _add(self, files, ids, kinds):
172
 
        """Helper function for add - updates the inventory.
173
 
 
174
 
        :param files: sequence of pathnames, relative to the tree root
175
 
        :param ids: sequence of suggested ids for the files (may be None)
176
 
        :param kinds: sequence of  inventory kinds of the files (i.e. may
177
 
            contain "tree-reference")
178
 
        """
179
 
        raise NotImplementedError(self._add)
180
 
 
181
 
    def apply_inventory_delta(self, changes):
182
 
        """Apply changes to the inventory as an atomic operation.
183
 
 
184
 
        :param changes: An inventory delta to apply to the working tree's
185
 
            inventory.
186
 
        :return None:
187
 
        :seealso Inventory.apply_delta: For details on the changes parameter.
188
 
        """
189
 
        raise NotImplementedError(self.apply_inventory_delta)
190
 
 
191
 
    @needs_write_lock
192
 
    def commit(self, message=None, revprops=None, *args,
193
 
               **kwargs):
194
 
        # avoid circular imports
195
 
        from bzrlib import commit
196
 
        possible_master_transports=[]
197
 
        revprops = commit.Commit.update_revprops(
198
 
                revprops,
199
 
                self.branch,
200
 
                kwargs.pop('authors', None),
201
 
                kwargs.pop('author', None),
202
 
                kwargs.get('local', False),
203
 
                possible_master_transports)
204
 
        # args for wt.commit start at message from the Commit.commit method,
205
 
        args = (message, ) + args
206
 
        for hook in MutableTree.hooks['start_commit']:
207
 
            hook(self)
208
 
        committed_id = commit.Commit().commit(working_tree=self,
209
 
            revprops=revprops,
210
 
            possible_master_transports=possible_master_transports,
211
 
            *args, **kwargs)
212
 
        post_hook_params = PostCommitHookParams(self)
213
 
        for hook in MutableTree.hooks['post_commit']:
214
 
            hook(post_hook_params)
215
 
        return committed_id
216
 
 
217
 
    def _gather_kinds(self, files, kinds):
218
 
        """Helper function for add - sets the entries of kinds."""
219
 
        raise NotImplementedError(self._gather_kinds)
220
 
 
221
 
    @needs_read_lock
222
 
    def has_changes(self, _from_tree=None):
223
 
        """Quickly check that the tree contains at least one commitable change.
224
 
 
225
 
        :param _from_tree: tree to compare against to find changes (default to
226
 
            the basis tree and is intended to be used by tests).
227
 
 
228
 
        :return: True if a change is found. False otherwise
229
 
        """
230
 
        # Check pending merges
231
 
        if len(self.get_parent_ids()) > 1:
232
 
            return True
233
 
        if _from_tree is None:
234
 
            _from_tree = self.basis_tree()
235
 
        changes = self.iter_changes(_from_tree)
236
 
        try:
237
 
            change = changes.next()
238
 
            # Exclude root (talk about black magic... --vila 20090629)
239
 
            if change[4] == (None, None):
240
 
                change = changes.next()
241
 
            return True
242
 
        except StopIteration:
243
 
            # No changes
244
 
            return False
245
 
 
246
 
    @needs_read_lock
247
 
    def check_changed_or_out_of_date(self, strict, opt_name,
248
 
                                     more_error, more_warning):
249
 
        """Check the tree for uncommitted changes and branch synchronization.
250
 
 
251
 
        If strict is None and not set in the config files, a warning is issued.
252
 
        If strict is True, an error is raised.
253
 
        If strict is False, no checks are done and no warning is issued.
254
 
 
255
 
        :param strict: True, False or None, searched in branch config if None.
256
 
 
257
 
        :param opt_name: strict option name to search in config file.
258
 
 
259
 
        :param more_error: Details about how to avoid the check.
260
 
 
261
 
        :param more_warning: Details about what is happening.
262
 
        """
263
 
        if strict is None:
264
 
            strict = self.branch.get_config_stack().get(opt_name)
265
 
        if strict is not False:
266
 
            err_class = None
267
 
            if (self.has_changes()):
268
 
                err_class = errors.UncommittedChanges
269
 
            elif self.last_revision() != self.branch.last_revision():
270
 
                # The tree has lost sync with its branch, there is little
271
 
                # chance that the user is aware of it but he can still force
272
 
                # the action with --no-strict
273
 
                err_class = errors.OutOfDateTree
274
 
            if err_class is not None:
275
 
                if strict is None:
276
 
                    err = err_class(self, more=more_warning)
277
 
                    # We don't want to interrupt the user if he expressed no
278
 
                    # preference about strict.
279
 
                    trace.warning('%s', err._format())
280
 
                else:
281
 
                    err = err_class(self, more=more_error)
282
 
                    raise err
283
 
 
284
 
    @needs_read_lock
285
 
    def last_revision(self):
286
 
        """Return the revision id of the last commit performed in this tree.
287
 
 
288
 
        In early tree formats the result of last_revision is the same as the
289
 
        branch last_revision, but that is no longer the case for modern tree
290
 
        formats.
291
 
 
292
 
        last_revision returns the left most parent id, or None if there are no
293
 
        parents.
294
 
 
295
 
        last_revision was deprecated as of 0.11. Please use get_parent_ids
296
 
        instead.
297
 
        """
298
 
        raise NotImplementedError(self.last_revision)
299
 
 
300
 
    def lock_tree_write(self):
301
 
        """Lock the working tree for write, and the branch for read.
302
 
 
303
 
        This is useful for operations which only need to mutate the working
304
 
        tree. Taking out branch write locks is a relatively expensive process
305
 
        and may fail if the branch is on read only media. So branch write locks
306
 
        should only be taken out when we are modifying branch data - such as in
307
 
        operations like commit, pull, uncommit and update.
308
 
        """
309
 
        raise NotImplementedError(self.lock_tree_write)
310
 
 
311
 
    def lock_write(self):
312
 
        """Lock the tree and its branch. This allows mutating calls to be made.
313
 
 
314
 
        Some mutating methods will take out implicit write locks, but in
315
 
        general you should always obtain a write lock before calling mutating
316
 
        methods on a tree.
317
 
        """
318
 
        raise NotImplementedError(self.lock_write)
319
 
 
320
 
    @needs_write_lock
321
 
    def mkdir(self, path, file_id=None):
322
 
        """Create a directory in the tree. if file_id is None, one is assigned.
323
 
 
324
 
        :param path: A unicode file path.
325
 
        :param file_id: An optional file-id.
326
 
        :return: the file id of the new directory.
327
 
        """
328
 
        raise NotImplementedError(self.mkdir)
329
 
 
330
 
    def _observed_sha1(self, file_id, path, (sha1, stat_value)):
331
 
        """Tell the tree we have observed a paths sha1.
332
 
 
333
 
        The intent of this function is to allow trees that have a hashcache to
334
 
        update the hashcache during commit. If the observed file is too new
335
 
        (based on the stat_value) to be safely hash-cached the tree will ignore
336
 
        it.
337
 
 
338
 
        The default implementation does nothing.
339
 
 
340
 
        :param file_id: The file id
341
 
        :param path: The file path
342
 
        :param sha1: The sha 1 that was observed.
343
 
        :param stat_value: A stat result for the file the sha1 was read from.
344
 
        :return: None
345
 
        """
346
 
 
347
 
    @needs_write_lock
348
 
    def put_file_bytes_non_atomic(self, file_id, bytes):
349
 
        """Update the content of a file in the tree.
350
 
 
351
 
        Note that the file is written in-place rather than being
352
 
        written to a temporary location and renamed. As a consequence,
353
 
        readers can potentially see the file half-written.
354
 
 
355
 
        :param file_id: file-id of the file
356
 
        :param bytes: the new file contents
357
 
        """
358
 
        raise NotImplementedError(self.put_file_bytes_non_atomic)
359
 
 
360
 
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
361
 
        """Set the parents ids of the working tree.
362
 
 
363
 
        :param revision_ids: A list of revision_ids.
364
 
        """
365
 
        raise NotImplementedError(self.set_parent_ids)
366
 
 
367
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
368
 
        """Set the parents of the working tree.
369
 
 
370
 
        :param parents_list: A list of (revision_id, tree) tuples.
371
 
            If tree is None, then that element is treated as an unreachable
372
 
            parent tree - i.e. a ghost.
373
 
        """
374
 
        raise NotImplementedError(self.set_parent_trees)
375
 
 
376
 
    def smart_add(self, file_list, recurse=True, action=None, save=True):
377
 
        """Version file_list, optionally recursing into directories.
378
 
 
379
 
        This is designed more towards DWIM for humans than API clarity.
380
 
        For the specific behaviour see the help for cmd_add().
381
 
 
382
 
        :param file_list: List of zero or more paths.  *NB: these are 
383
 
            interpreted relative to the process cwd, not relative to the 
384
 
            tree.*  (Add and most other tree methods use tree-relative
385
 
            paths.)
386
 
        :param action: A reporter to be called with the inventory, parent_ie,
387
 
            path and kind of the path being added. It may return a file_id if
388
 
            a specific one should be used.
389
 
        :param save: Save the inventory after completing the adds. If False
390
 
            this provides dry-run functionality by doing the add and not saving
391
 
            the inventory.
392
 
        :return: A tuple - files_added, ignored_files. files_added is the count
393
 
            of added files, and ignored_files is a dict mapping files that were
394
 
            ignored to the rule that caused them to be ignored.
395
 
        """
396
 
        raise NotImplementedError(self.smart_add)
397
 
 
398
 
 
399
 
class MutableInventoryTree(MutableTree, tree.InventoryTree):
400
 
 
401
 
    @needs_tree_write_lock
402
 
    def apply_inventory_delta(self, changes):
403
 
        """Apply changes to the inventory as an atomic operation.
404
 
 
405
 
        :param changes: An inventory delta to apply to the working tree's
406
 
            inventory.
407
 
        :return None:
408
 
        :seealso Inventory.apply_delta: For details on the changes parameter.
409
 
        """
410
 
        self.flush()
411
 
        inv = self.root_inventory
412
 
        inv.apply_delta(changes)
413
 
        self._write_inventory(inv)
414
 
 
415
 
    def _fix_case_of_inventory_path(self, path):
416
 
        """If our tree isn't case sensitive, return the canonical path"""
417
 
        if not self.case_sensitive:
418
 
            path = self.get_canonical_inventory_path(path)
419
 
        return path
420
 
 
421
 
    @needs_tree_write_lock
422
 
    def smart_add(self, file_list, recurse=True, action=None, save=True):
423
 
        """Version file_list, optionally recursing into directories.
424
 
 
425
 
        This is designed more towards DWIM for humans than API clarity.
426
 
        For the specific behaviour see the help for cmd_add().
427
 
 
428
 
        :param file_list: List of zero or more paths.  *NB: these are 
429
 
            interpreted relative to the process cwd, not relative to the 
430
 
            tree.*  (Add and most other tree methods use tree-relative
431
 
            paths.)
432
 
        :param action: A reporter to be called with the inventory, parent_ie,
433
 
            path and kind of the path being added. It may return a file_id if
434
 
            a specific one should be used.
435
 
        :param save: Save the inventory after completing the adds. If False
436
 
            this provides dry-run functionality by doing the add and not saving
437
 
            the inventory.
438
 
        :return: A tuple - files_added, ignored_files. files_added is the count
439
 
            of added files, and ignored_files is a dict mapping files that were
440
 
            ignored to the rule that caused them to be ignored.
441
 
        """
442
 
        # Not all mutable trees can have conflicts
443
 
        if getattr(self, 'conflicts', None) is not None:
444
 
            # Collect all related files without checking whether they exist or
445
 
            # are versioned. It's cheaper to do that once for all conflicts
446
 
            # than trying to find the relevant conflict for each added file.
447
 
            conflicts_related = set()
448
 
            for c in self.conflicts():
449
 
                conflicts_related.update(c.associated_filenames())
450
 
        else:
451
 
            conflicts_related = None
452
 
        adder = _SmartAddHelper(self, action, conflicts_related)
453
 
        adder.add(file_list, recurse=recurse)
454
 
        if save:
455
 
            invdelta = adder.get_inventory_delta()
456
 
            self.apply_inventory_delta(invdelta)
457
 
        return adder.added, adder.ignored
458
 
 
459
 
    def update_basis_by_delta(self, new_revid, delta):
460
 
        """Update the parents of this tree after a commit.
461
 
 
462
 
        This gives the tree one parent, with revision id new_revid. The
463
 
        inventory delta is applied to the current basis tree to generate the
464
 
        inventory for the parent new_revid, and all other parent trees are
465
 
        discarded.
466
 
 
467
 
        All the changes in the delta should be changes synchronising the basis
468
 
        tree with some or all of the working tree, with a change to a directory
469
 
        requiring that its contents have been recursively included. That is,
470
 
        this is not a general purpose tree modification routine, but a helper
471
 
        for commit which is not required to handle situations that do not arise
472
 
        outside of commit.
473
 
 
474
 
        See the inventory developers documentation for the theory behind
475
 
        inventory deltas.
476
 
 
477
 
        :param new_revid: The new revision id for the trees parent.
478
 
        :param delta: An inventory delta (see apply_inventory_delta) describing
479
 
            the changes from the current left most parent revision to new_revid.
480
 
        """
481
 
        # if the tree is updated by a pull to the branch, as happens in
482
 
        # WorkingTree2, when there was no separation between branch and tree,
483
 
        # then just clear merges, efficiency is not a concern for now as this
484
 
        # is legacy environments only, and they are slow regardless.
485
 
        if self.last_revision() == new_revid:
486
 
            self.set_parent_ids([new_revid])
487
 
            return
488
 
        # generic implementation based on Inventory manipulation. See
489
 
        # WorkingTree classes for optimised versions for specific format trees.
490
 
        basis = self.basis_tree()
491
 
        basis.lock_read()
492
 
        # TODO: Consider re-evaluating the need for this with CHKInventory
493
 
        # we don't strictly need to mutate an inventory for this
494
 
        # it only makes sense when apply_delta is cheaper than get_inventory()
495
 
        inventory = _mod_inventory.mutable_inventory_from_tree(basis)
496
 
        basis.unlock()
497
 
        inventory.apply_delta(delta)
498
 
        rev_tree = revisiontree.InventoryRevisionTree(self.branch.repository,
499
 
                                             inventory, new_revid)
500
 
        self.set_parent_trees([(new_revid, rev_tree)])
501
 
 
502
 
 
503
 
class MutableTreeHooks(hooks.Hooks):
504
 
    """A dictionary mapping a hook name to a list of callables for mutabletree
505
 
    hooks.
506
 
    """
507
 
 
508
 
    def __init__(self):
509
 
        """Create the default hooks.
510
 
 
511
 
        """
512
 
        hooks.Hooks.__init__(self, "bzrlib.mutabletree", "MutableTree.hooks")
513
 
        self.add_hook('start_commit',
514
 
            "Called before a commit is performed on a tree. The start commit "
515
 
            "hook is able to change the tree before the commit takes place. "
516
 
            "start_commit is called with the bzrlib.mutabletree.MutableTree "
517
 
            "that the commit is being performed on.", (1, 4))
518
 
        self.add_hook('post_commit',
519
 
            "Called after a commit is performed on a tree. The hook is "
520
 
            "called with a bzrlib.mutabletree.PostCommitHookParams object. "
521
 
            "The mutable tree the commit was performed on is available via "
522
 
            "the mutable_tree attribute of that object.", (2, 0))
523
 
        self.add_hook('pre_transform',
524
 
            "Called before a tree transform on this tree. The hook is called "
525
 
            "with the tree that is being transformed and the transform.",
526
 
            (2, 5))
527
 
        self.add_hook('post_build_tree',
528
 
            "Called after a completely new tree is built. The hook is "
529
 
            "called with the tree as its only argument.", (2, 5))
530
 
        self.add_hook('post_transform',
531
 
            "Called after a tree transform has been performed on a tree. "
532
 
            "The hook is called with the tree that is being transformed and "
533
 
            "the transform.",
534
 
            (2, 5))
535
 
 
536
 
# install the default hooks into the MutableTree class.
537
 
MutableTree.hooks = MutableTreeHooks()
538
 
 
539
 
 
540
 
class PostCommitHookParams(object):
541
 
    """Parameters for the post_commit hook.
542
 
 
543
 
    To access the parameters, use the following attributes:
544
 
 
545
 
    * mutable_tree - the MutableTree object
546
 
    """
547
 
 
548
 
    def __init__(self, mutable_tree):
549
 
        """Create the parameters for the post_commit hook."""
550
 
        self.mutable_tree = mutable_tree
551
 
 
552
 
 
553
 
class _SmartAddHelper(object):
554
 
    """Helper for MutableTree.smart_add."""
555
 
 
556
 
    def get_inventory_delta(self):
557
 
        return self._invdelta.values()
558
 
 
559
 
    def _get_ie(self, inv_path):
560
 
        """Retrieve the most up to date inventory entry for a path.
561
 
 
562
 
        :param inv_path: Normalized inventory path
563
 
        :return: Inventory entry (with possibly invalid .children for
564
 
            directories)
565
 
        """
566
 
        entry = self._invdelta.get(inv_path)
567
 
        if entry is not None:
568
 
            return entry[3]
569
 
        # Find a 'best fit' match if the filesystem is case-insensitive
570
 
        inv_path = self.tree._fix_case_of_inventory_path(inv_path)
571
 
        file_id = self.tree.path2id(inv_path)
572
 
        if file_id is not None:
573
 
            return self.tree.iter_entries_by_dir([file_id]).next()[1]
574
 
        return None
575
 
 
576
 
    def _convert_to_directory(self, this_ie, inv_path):
577
 
        """Convert an entry to a directory.
578
 
 
579
 
        :param this_ie: Inventory entry
580
 
        :param inv_path: Normalized path for the inventory entry
581
 
        :return: The new inventory entry
582
 
        """
583
 
        # Same as in _add_one below, if the inventory doesn't
584
 
        # think this is a directory, update the inventory
585
 
        this_ie = _mod_inventory.InventoryDirectory(
586
 
            this_ie.file_id, this_ie.name, this_ie.parent_id)
587
 
        self._invdelta[inv_path] = (inv_path, inv_path, this_ie.file_id,
588
 
            this_ie)
589
 
        return this_ie
590
 
 
591
 
    def _add_one_and_parent(self, parent_ie, path, kind, inv_path):
592
 
        """Add a new entry to the inventory and automatically add unversioned parents.
593
 
 
594
 
        :param parent_ie: Parent inventory entry if known, or None.  If
595
 
            None, the parent is looked up by name and used if present, otherwise it
596
 
            is recursively added.
597
 
        :param path: 
598
 
        :param kind: Kind of new entry (file, directory, etc)
599
 
        :param inv_path:
600
 
        :return: Inventory entry for path and a list of paths which have been added.
601
 
        """
602
 
        # Nothing to do if path is already versioned.
603
 
        # This is safe from infinite recursion because the tree root is
604
 
        # always versioned.
605
 
        inv_dirname = osutils.dirname(inv_path)
606
 
        dirname, basename = osutils.split(path)
607
 
        if parent_ie is None:
608
 
            # slower but does not need parent_ie
609
 
            this_ie = self._get_ie(inv_path)
610
 
            if this_ie is not None:
611
 
                return this_ie
612
 
            # its really not there : add the parent
613
 
            # note that the dirname use leads to some extra str copying etc but as
614
 
            # there are a limited number of dirs we can be nested under, it should
615
 
            # generally find it very fast and not recurse after that.
616
 
            parent_ie = self._add_one_and_parent(None,
617
 
                dirname, 'directory', 
618
 
                inv_dirname)
619
 
        # if the parent exists, but isn't a directory, we have to do the
620
 
        # kind change now -- really the inventory shouldn't pretend to know
621
 
        # the kind of wt files, but it does.
622
 
        if parent_ie.kind != 'directory':
623
 
            # nb: this relies on someone else checking that the path we're using
624
 
            # doesn't contain symlinks.
625
 
            parent_ie = self._convert_to_directory(parent_ie, inv_dirname)
626
 
        file_id = self.action(self.tree, parent_ie, path, kind)
627
 
        entry = _mod_inventory.make_entry(kind, basename, parent_ie.file_id,
628
 
            file_id=file_id)
629
 
        self._invdelta[inv_path] = (None, inv_path, entry.file_id, entry)
630
 
        self.added.append(inv_path)
631
 
        return entry
632
 
 
633
 
    def _gather_dirs_to_add(self, user_dirs):
634
 
        # only walk the minimal parents needed: we have user_dirs to override
635
 
        # ignores.
636
 
        prev_dir = None
637
 
 
638
 
        is_inside = osutils.is_inside_or_parent_of_any
639
 
        for path, (inv_path, this_ie) in sorted(
640
 
                user_dirs.iteritems(), key=operator.itemgetter(0)):
641
 
            if (prev_dir is None or not is_inside([prev_dir], path)):
642
 
                yield (path, inv_path, this_ie, None)
643
 
            prev_dir = path
644
 
        
645
 
    def __init__(self, tree, action, conflicts_related=None):
646
 
        self.tree = tree
647
 
        if action is None:
648
 
            self.action = add.AddAction()
649
 
        else:
650
 
            self.action = action
651
 
        self._invdelta = {}
652
 
        self.added = []
653
 
        self.ignored = {}
654
 
        if conflicts_related is None:
655
 
            self.conflicts_related = frozenset()
656
 
        else:
657
 
            self.conflicts_related = conflicts_related
658
 
 
659
 
    def add(self, file_list, recurse=True):
660
 
        from bzrlib.inventory import InventoryEntry
661
 
        if not file_list:
662
 
            # no paths supplied: add the entire tree.
663
 
            # FIXME: this assumes we are running in a working tree subdir :-/
664
 
            # -- vila 20100208
665
 
            file_list = [u'.']
666
 
 
667
 
        # expand any symlinks in the directory part, while leaving the
668
 
        # filename alone
669
 
        # only expanding if symlinks are supported avoids windows path bugs
670
 
        if osutils.has_symlinks():
671
 
            file_list = map(osutils.normalizepath, file_list)
672
 
 
673
 
        user_dirs = {}
674
 
        # validate user file paths and convert all paths to tree
675
 
        # relative : it's cheaper to make a tree relative path an abspath
676
 
        # than to convert an abspath to tree relative, and it's cheaper to
677
 
        # perform the canonicalization in bulk.
678
 
        for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
679
 
            # validate user parameters. Our recursive code avoids adding new
680
 
            # files that need such validation
681
 
            if self.tree.is_control_filename(filepath):
682
 
                raise errors.ForbiddenControlFileError(filename=filepath)
683
 
 
684
 
            abspath = self.tree.abspath(filepath)
685
 
            kind = osutils.file_kind(abspath)
686
 
            # ensure the named path is added, so that ignore rules in the later
687
 
            # directory walk dont skip it.
688
 
            # we dont have a parent ie known yet.: use the relatively slower
689
 
            # inventory probing method
690
 
            inv_path, _ = osutils.normalized_filename(filepath)
691
 
            this_ie = self._get_ie(inv_path)
692
 
            if this_ie is None:
693
 
                this_ie = self._add_one_and_parent(None, filepath, kind, inv_path)
694
 
            if kind == 'directory':
695
 
                # schedule the dir for scanning
696
 
                user_dirs[filepath] = (inv_path, this_ie)
697
 
 
698
 
        if not recurse:
699
 
            # no need to walk any directories at all.
700
 
            return
701
 
 
702
 
        things_to_add = list(self._gather_dirs_to_add(user_dirs))
703
 
 
704
 
        illegalpath_re = re.compile(r'[\r\n]')
705
 
        for directory, inv_path, this_ie, parent_ie in things_to_add:
706
 
            # directory is tree-relative
707
 
            abspath = self.tree.abspath(directory)
708
 
 
709
 
            # get the contents of this directory.
710
 
 
711
 
            # find the kind of the path being added, and save stat_value
712
 
            # for reuse
713
 
            stat_value = None
714
 
            if this_ie is None:
715
 
                stat_value = osutils.file_stat(abspath)
716
 
                kind = osutils.file_kind_from_stat_mode(stat_value.st_mode)
717
 
            else:
718
 
                kind = this_ie.kind
719
 
            
720
 
            # allow AddAction to skip this file
721
 
            if self.action.skip_file(self.tree,  abspath,  kind,  stat_value):
722
 
                continue
723
 
            if not InventoryEntry.versionable_kind(kind):
724
 
                trace.warning("skipping %s (can't add file of kind '%s')",
725
 
                              abspath, kind)
726
 
                continue
727
 
            if illegalpath_re.search(directory):
728
 
                trace.warning("skipping %r (contains \\n or \\r)" % abspath)
729
 
                continue
730
 
            if directory in self.conflicts_related:
731
 
                # If the file looks like one generated for a conflict, don't
732
 
                # add it.
733
 
                trace.warning(
734
 
                    'skipping %s (generated to help resolve conflicts)',
735
 
                    abspath)
736
 
                continue
737
 
 
738
 
            if kind == 'directory' and directory != '':
739
 
                try:
740
 
                    transport = _mod_transport.get_transport_from_path(abspath)
741
 
                    controldir.ControlDirFormat.find_format(transport)
742
 
                    sub_tree = True
743
 
                except errors.NotBranchError:
744
 
                    sub_tree = False
745
 
                except errors.UnsupportedFormatError:
746
 
                    sub_tree = True
747
 
            else:
748
 
                sub_tree = False
749
 
 
750
 
            if this_ie is not None:
751
 
                pass
752
 
            elif sub_tree:
753
 
                # XXX: This is wrong; people *might* reasonably be trying to
754
 
                # add subtrees as subtrees.  This should probably only be done
755
 
                # in formats which can represent subtrees, and even then
756
 
                # perhaps only when the user asked to add subtrees.  At the
757
 
                # moment you can add them specially through 'join --reference',
758
 
                # which is perhaps reasonable: adding a new reference is a
759
 
                # special operation and can have a special behaviour.  mbp
760
 
                # 20070306
761
 
                trace.warning("skipping nested tree %r", abspath)
762
 
            else:
763
 
                this_ie = self._add_one_and_parent(parent_ie, directory, kind,
764
 
                    inv_path)
765
 
 
766
 
            if kind == 'directory' and not sub_tree:
767
 
                if this_ie.kind != 'directory':
768
 
                    this_ie = self._convert_to_directory(this_ie, inv_path)
769
 
 
770
 
                for subf in sorted(os.listdir(abspath)):
771
 
                    inv_f, _ = osutils.normalized_filename(subf)
772
 
                    # here we could use TreeDirectory rather than
773
 
                    # string concatenation.
774
 
                    subp = osutils.pathjoin(directory, subf)
775
 
                    # TODO: is_control_filename is very slow. Make it faster.
776
 
                    # TreeDirectory.is_control_filename could also make this
777
 
                    # faster - its impossible for a non root dir to have a
778
 
                    # control file.
779
 
                    if self.tree.is_control_filename(subp):
780
 
                        trace.mutter("skip control directory %r", subp)
781
 
                        continue
782
 
                    sub_invp = osutils.pathjoin(inv_path, inv_f)
783
 
                    entry = self._invdelta.get(sub_invp)
784
 
                    if entry is not None:
785
 
                        sub_ie = entry[3]
786
 
                    else:
787
 
                        sub_ie = this_ie.children.get(inv_f)
788
 
                    if sub_ie is not None:
789
 
                        # recurse into this already versioned subdir.
790
 
                        things_to_add.append((subp, sub_invp, sub_ie, this_ie))
791
 
                    else:
792
 
                        # user selection overrides ignores
793
 
                        # ignore while selecting files - if we globbed in the
794
 
                        # outer loop we would ignore user files.
795
 
                        ignore_glob = self.tree.is_ignored(subp)
796
 
                        if ignore_glob is not None:
797
 
                            self.ignored.setdefault(ignore_glob, []).append(subp)
798
 
                        else:
799
 
                            things_to_add.append((subp, sub_invp, None, this_ie))