~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/mutabletree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-01-02 08:23:44 UTC
  • mfrom: (3140.1.9 find-branches)
  • Revision ID: pqm@pqm.ubuntu.com-20080102082344-qret383z2bdk1ud4
Optimize find_branches for standalone repositories (abentley)

Show diffs side-by-side

added added

removed removed

Lines of Context:
20
20
"""
21
21
 
22
22
 
 
23
from bzrlib.lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
import os
 
26
 
 
27
from bzrlib import (
 
28
    add,
 
29
    bzrdir,
 
30
    )
 
31
from bzrlib.osutils import dirname
 
32
from bzrlib.revisiontree import RevisionTree
 
33
from bzrlib.trace import mutter, warning
 
34
""")
 
35
 
23
36
from bzrlib import (
24
37
    errors,
25
38
    osutils,
96
109
            ids = [None] * len(files)
97
110
        else:
98
111
            assert(len(ids) == len(files))
99
 
            ids = [osutils.safe_file_id(file_id) for file_id in ids]
100
 
 
101
112
        if kinds is None:
102
113
            kinds = [None] * len(files)
103
114
        else:
147
158
    def apply_inventory_delta(self, changes):
148
159
        """Apply changes to the inventory as an atomic operation.
149
160
 
150
 
        The argument is a set of changes to apply.  It must describe a
151
 
        valid result, but the order is not important.  Specifically,
152
 
        intermediate stages *may* be invalid, such as when two files
153
 
        swap names.
154
 
 
155
 
        The changes should be structured as a list of tuples, of the form
156
 
        (old_path, new_path, file_id, new_entry).  For creation, old_path
157
 
        must be None.  For deletion, new_path and new_entry must be None.
158
 
        file_id is always non-None.  For renames and other mutations, all
159
 
        values must be non-None.
160
 
 
161
 
        If the new_entry is a directory, its children should be an empty
162
 
        dict.  Children are handled by apply_inventory_delta itself.
163
 
 
164
 
        :param changes: A list of tuples for the change to apply:
165
 
            [(old_path, new_path, file_id, new_inventory_entry), ...]
 
161
        :param changes: An inventory delta to apply to the working tree's
 
162
            inventory.
 
163
        :return None:
 
164
        :seealso Inventory.apply_delta: For details on the changes parameter.
166
165
        """
167
166
        self.flush()
168
167
        inv = self.inventory
169
 
        children = {}
170
 
        for old_path, file_id in sorted(((op, f) for op, np, f, e in changes
171
 
                                        if op is not None), reverse=True):
172
 
            if file_id not in inv:
173
 
                continue
174
 
            children[file_id] = getattr(inv[file_id], 'children', {})
175
 
            inv.remove_recursive_id(file_id)
176
 
        for new_path, new_entry in sorted((np, e) for op, np, f, e in
177
 
                                          changes if np is not None):
178
 
            if getattr(new_entry, 'children', None) is not None:
179
 
                new_entry.children = children.get(new_entry.file_id, {})
180
 
            inv.add(new_entry)
 
168
        inv.apply_delta(changes)
181
169
        self._write_inventory(inv)
182
170
 
183
171
    @needs_write_lock
189
177
            revprops = {}
190
178
        if not 'branch-nick' in revprops:
191
179
            revprops['branch-nick'] = self.branch.nick
 
180
        author = kwargs.pop('author', None)
 
181
        if author is not None:
 
182
            assert 'author' not in revprops
 
183
            revprops['author'] = author
192
184
        # args for wt.commit start at message from the Commit.commit method,
193
185
        args = (message, ) + args
194
186
        committed_id = commit.Commit().commit(working_tree=self,
260
252
            parent tree - i.e. a ghost.
261
253
        """
262
254
        raise NotImplementedError(self.set_parent_trees)
 
255
 
 
256
    @needs_tree_write_lock
 
257
    def smart_add(self, file_list, recurse=True, action=None, save=True):
 
258
        """Version file_list, optionally recursing into directories.
 
259
 
 
260
        This is designed more towards DWIM for humans than API clarity.
 
261
        For the specific behaviour see the help for cmd_add().
 
262
 
 
263
        :param action: A reporter to be called with the inventory, parent_ie,
 
264
            path and kind of the path being added. It may return a file_id if 
 
265
            a specific one should be used.
 
266
        :param save: Save the inventory after completing the adds. If False
 
267
            this provides dry-run functionality by doing the add and not saving
 
268
            the inventory.
 
269
        :return: A tuple - files_added, ignored_files. files_added is the count
 
270
            of added files, and ignored_files is a dict mapping files that were
 
271
            ignored to the rule that caused them to be ignored.
 
272
        """
 
273
        # not in an inner loop; and we want to remove direct use of this,
 
274
        # so here as a reminder for now. RBC 20070703
 
275
        from bzrlib.inventory import InventoryEntry
 
276
        assert isinstance(recurse, bool)
 
277
        if action is None:
 
278
            action = add.AddAction()
 
279
        
 
280
        if not file_list:
 
281
            # no paths supplied: add the entire tree.
 
282
            file_list = [u'.']
 
283
        # mutter("smart add of %r")
 
284
        inv = self.inventory
 
285
        added = []
 
286
        ignored = {}
 
287
        dirs_to_add = []
 
288
        user_dirs = set()
 
289
 
 
290
        # validate user file paths and convert all paths to tree 
 
291
        # relative : it's cheaper to make a tree relative path an abspath
 
292
        # than to convert an abspath to tree relative.
 
293
        for filepath in file_list:
 
294
            rf = _FastPath(self.relpath(filepath))
 
295
            # validate user parameters. Our recursive code avoids adding new files
 
296
            # that need such validation 
 
297
            if self.is_control_filename(rf.raw_path):
 
298
                raise errors.ForbiddenControlFileError(filename=rf.raw_path)
 
299
            
 
300
            abspath = self.abspath(rf.raw_path)
 
301
            kind = osutils.file_kind(abspath)
 
302
            if kind == 'directory':
 
303
                # schedule the dir for scanning
 
304
                user_dirs.add(rf)
 
305
            else:
 
306
                if not InventoryEntry.versionable_kind(kind):
 
307
                    raise errors.BadFileKindError(filename=abspath, kind=kind)
 
308
            # ensure the named path is added, so that ignore rules in the later directory
 
309
            # walk dont skip it.
 
310
            # we dont have a parent ie known yet.: use the relatively slower inventory 
 
311
            # probing method
 
312
            versioned = inv.has_filename(rf.raw_path)
 
313
            if versioned:
 
314
                continue
 
315
            added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
 
316
 
 
317
        if not recurse:
 
318
            # no need to walk any directories at all.
 
319
            if len(added) > 0 and save:
 
320
                self._write_inventory(inv)
 
321
            return added, ignored
 
322
 
 
323
        # only walk the minimal parents needed: we have user_dirs to override
 
324
        # ignores.
 
325
        prev_dir = None
 
326
 
 
327
        is_inside = osutils.is_inside_or_parent_of_any
 
328
        for path in sorted(user_dirs):
 
329
            if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
 
330
                dirs_to_add.append((path, None))
 
331
            prev_dir = path.raw_path
 
332
 
 
333
        # dirs_to_add is initialised to a list of directories, but as we scan
 
334
        # directories we append files to it.
 
335
        # XXX: We should determine kind of files when we scan them rather than
 
336
        # adding to this list. RBC 20070703
 
337
        for directory, parent_ie in dirs_to_add:
 
338
            # directory is tree-relative
 
339
            abspath = self.abspath(directory.raw_path)
 
340
 
 
341
            # get the contents of this directory.
 
342
 
 
343
            # find the kind of the path being added.
 
344
            kind = osutils.file_kind(abspath)
 
345
 
 
346
            if not InventoryEntry.versionable_kind(kind):
 
347
                warning("skipping %s (can't add file of kind '%s')", abspath, kind)
 
348
                continue
 
349
 
 
350
            if parent_ie is not None:
 
351
                versioned = directory.base_path in parent_ie.children
 
352
            else:
 
353
                # without the parent ie, use the relatively slower inventory 
 
354
                # probing method
 
355
                versioned = inv.has_filename(directory.raw_path)
 
356
 
 
357
            if kind == 'directory':
 
358
                try:
 
359
                    sub_branch = bzrdir.BzrDir.open(abspath)
 
360
                    sub_tree = True
 
361
                except errors.NotBranchError:
 
362
                    sub_tree = False
 
363
                except errors.UnsupportedFormatError:
 
364
                    sub_tree = True
 
365
            else:
 
366
                sub_tree = False
 
367
 
 
368
            if directory.raw_path == '':
 
369
                # mutter("tree root doesn't need to be added")
 
370
                sub_tree = False
 
371
            elif versioned:
 
372
                pass
 
373
                # mutter("%r is already versioned", abspath)
 
374
            elif sub_tree:
 
375
                # XXX: This is wrong; people *might* reasonably be trying to add
 
376
                # subtrees as subtrees.  This should probably only be done in formats 
 
377
                # which can represent subtrees, and even then perhaps only when
 
378
                # the user asked to add subtrees.  At the moment you can add them
 
379
                # specially through 'join --reference', which is perhaps
 
380
                # reasonable: adding a new reference is a special operation and
 
381
                # can have a special behaviour.  mbp 20070306
 
382
                mutter("%r is a nested bzr tree", abspath)
 
383
            else:
 
384
                _add_one(self, inv, parent_ie, directory, kind, action)
 
385
                added.append(directory.raw_path)
 
386
 
 
387
            if kind == 'directory' and not sub_tree:
 
388
                if parent_ie is not None:
 
389
                    # must be present:
 
390
                    this_ie = parent_ie.children[directory.base_path]
 
391
                else:
 
392
                    # without the parent ie, use the relatively slower inventory 
 
393
                    # probing method
 
394
                    this_id = inv.path2id(directory.raw_path)
 
395
                    if this_id is None:
 
396
                        this_ie = None
 
397
                    else:
 
398
                        this_ie = inv[this_id]
 
399
 
 
400
                for subf in sorted(os.listdir(abspath)):
 
401
                    # here we could use TreeDirectory rather than 
 
402
                    # string concatenation.
 
403
                    subp = osutils.pathjoin(directory.raw_path, subf)
 
404
                    # TODO: is_control_filename is very slow. Make it faster. 
 
405
                    # TreeDirectory.is_control_filename could also make this 
 
406
                    # faster - its impossible for a non root dir to have a 
 
407
                    # control file.
 
408
                    if self.is_control_filename(subp):
 
409
                        mutter("skip control directory %r", subp)
 
410
                    elif subf in this_ie.children:
 
411
                        # recurse into this already versioned subdir.
 
412
                        dirs_to_add.append((_FastPath(subp, subf), this_ie))
 
413
                    else:
 
414
                        # user selection overrides ignoes
 
415
                        # ignore while selecting files - if we globbed in the
 
416
                        # outer loop we would ignore user files.
 
417
                        ignore_glob = self.is_ignored(subp)
 
418
                        if ignore_glob is not None:
 
419
                            # mutter("skip ignored sub-file %r", subp)
 
420
                            ignored.setdefault(ignore_glob, []).append(subp)
 
421
                        else:
 
422
                            #mutter("queue to add sub-file %r", subp)
 
423
                            dirs_to_add.append((_FastPath(subp, subf), this_ie))
 
424
 
 
425
        if len(added) > 0:
 
426
            if save:
 
427
                self._write_inventory(inv)
 
428
            else:
 
429
                self.read_working_inventory()
 
430
        return added, ignored
 
431
 
 
432
    def update_basis_by_delta(self, new_revid, delta):
 
433
        """Update the parents of this tree after a commit.
 
434
 
 
435
        This gives the tree one parent, with revision id new_revid. The
 
436
        inventory delta is applied to the current basis tree to generate the
 
437
        inventory for the parent new_revid, and all other parent trees are
 
438
        discarded.
 
439
 
 
440
        All the changes in the delta should be changes synchronising the basis
 
441
        tree with some or all of the working tree, with a change to a directory
 
442
        requiring that its contents have been recursively included. That is,
 
443
        this is not a general purpose tree modification routine, but a helper
 
444
        for commit which is not required to handle situations that do not arise
 
445
        outside of commit.
 
446
 
 
447
        :param new_revid: The new revision id for the trees parent.
 
448
        :param delta: An inventory delta (see apply_inventory_delta) describing
 
449
            the changes from the current left most parent revision to new_revid.
 
450
        """
 
451
        # if the tree is updated by a pull to the branch, as happens in
 
452
        # WorkingTree2, when there was no separation between branch and tree,
 
453
        # then just clear merges, efficiency is not a concern for now as this
 
454
        # is legacy environments only, and they are slow regardless.
 
455
        if self.last_revision() == new_revid:
 
456
            self.set_parent_ids([new_revid])
 
457
            return
 
458
        # generic implementation based on Inventory manipulation. See
 
459
        # WorkingTree classes for optimised versions for specific format trees.
 
460
        basis = self.basis_tree()
 
461
        basis.lock_read()
 
462
        inventory = basis.inventory
 
463
        basis.unlock()
 
464
        inventory.apply_delta(delta)
 
465
        rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
 
466
        self.set_parent_trees([(new_revid, rev_tree)])
 
467
 
 
468
 
 
469
class _FastPath(object):
 
470
    """A path object with fast accessors for things like basename."""
 
471
 
 
472
    __slots__ = ['raw_path', 'base_path']
 
473
 
 
474
    def __init__(self, path, base_path=None):
 
475
        """Construct a FastPath from path."""
 
476
        if base_path is None:
 
477
            self.base_path = osutils.basename(path)
 
478
        else:
 
479
            self.base_path = base_path
 
480
        self.raw_path = path
 
481
 
 
482
    def __cmp__(self, other):
 
483
        return cmp(self.raw_path, other.raw_path)
 
484
 
 
485
    def __hash__(self):
 
486
        return hash(self.raw_path)
 
487
 
 
488
 
 
489
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
 
490
    """Add a new entry to the inventory and automatically add unversioned parents.
 
491
 
 
492
    :param inv: Inventory which will receive the new entry.
 
493
    :param parent_ie: Parent inventory entry if known, or None.  If
 
494
        None, the parent is looked up by name and used if present, otherwise it
 
495
        is recursively added.
 
496
    :param kind: Kind of new entry (file, directory, etc)
 
497
    :param action: callback(inv, parent_ie, path, kind); return ignored.
 
498
    :return: A list of paths which have been added.
 
499
    """
 
500
    # Nothing to do if path is already versioned.
 
501
    # This is safe from infinite recursion because the tree root is
 
502
    # always versioned.
 
503
    if parent_ie is not None:
 
504
        # we have a parent ie already
 
505
        added = []
 
506
    else:
 
507
        # slower but does not need parent_ie
 
508
        if inv.has_filename(path.raw_path):
 
509
            return []
 
510
        # its really not there : add the parent
 
511
        # note that the dirname use leads to some extra str copying etc but as
 
512
        # there are a limited number of dirs we can be nested under, it should
 
513
        # generally find it very fast and not recurse after that.
 
514
        added = _add_one_and_parent(tree, inv, None,
 
515
            _FastPath(dirname(path.raw_path)), 'directory', action)
 
516
        parent_id = inv.path2id(dirname(path.raw_path))
 
517
        parent_ie = inv[parent_id]
 
518
    _add_one(tree, inv, parent_ie, path, kind, action)
 
519
    return added + [path.raw_path]
 
520
 
 
521
 
 
522
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
 
523
    """Add a new entry to the inventory.
 
524
 
 
525
    :param inv: Inventory which will receive the new entry.
 
526
    :param parent_ie: Parent inventory entry.
 
527
    :param kind: Kind of new entry (file, directory, etc)
 
528
    :param file_id_callback: callback(inv, parent_ie, path, kind); return a
 
529
        file_id or None to generate a new file id
 
530
    :returns: None
 
531
    """
 
532
    file_id = file_id_callback(inv, parent_ie, path, kind)
 
533
    entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
 
534
        file_id=file_id)
 
535
    inv.add(entry)