/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/mutabletree.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
25
25
import os
 
26
import re
26
27
 
27
28
from bzrlib import (
28
29
    add,
29
30
    bzrdir,
 
31
    errors,
30
32
    hooks,
 
33
    osutils,
 
34
    revisiontree,
31
35
    symbol_versioning,
 
36
    trace,
 
37
    tree,
32
38
    )
33
 
from bzrlib.osutils import dirname
34
 
from bzrlib.revisiontree import RevisionTree
35
 
from bzrlib.trace import mutter, warning
36
39
""")
37
40
 
38
 
from bzrlib import (
39
 
    errors,
40
 
    osutils,
41
 
    tree,
42
 
    )
43
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
 
from bzrlib.osutils import splitpath
45
42
 
46
43
 
47
44
def needs_tree_write_lock(unbound):
129
126
            # generic constraint checks:
130
127
            if self.is_control_filename(f):
131
128
                raise errors.ForbiddenControlFileError(filename=f)
132
 
            fp = splitpath(f)
 
129
            fp = osutils.splitpath(f)
133
130
        # fill out file kinds for all files [not needed when we stop
134
131
        # caring about the instantaneous file kind within a uncommmitted tree
135
132
        #
226
223
            revprops=revprops,
227
224
            possible_master_transports=possible_master_transports,
228
225
            *args, **kwargs)
 
226
        post_hook_params = PostCommitHookParams(self)
 
227
        for hook in MutableTree.hooks['post_commit']:
 
228
            hook(post_hook_params)
229
229
        return committed_id
230
230
 
231
231
    def _gather_kinds(self, files, kinds):
233
233
        raise NotImplementedError(self._gather_kinds)
234
234
 
235
235
    @needs_read_lock
 
236
    def has_changes(self, _from_tree=None):
 
237
        """Quickly check that the tree contains at least one commitable change.
 
238
 
 
239
        :param _from_tree: tree to compare against to find changes (default to
 
240
            the basis tree and is intended to be used by tests).
 
241
 
 
242
        :return: True if a change is found. False otherwise
 
243
        """
 
244
        # Check pending merges
 
245
        if len(self.get_parent_ids()) > 1:
 
246
            return True
 
247
        if _from_tree is None:
 
248
            _from_tree = self.basis_tree()
 
249
        changes = self.iter_changes(_from_tree)
 
250
        try:
 
251
            change = changes.next()
 
252
            # Exclude root (talk about black magic... --vila 20090629)
 
253
            if change[4] == (None, None):
 
254
                change = changes.next()
 
255
            return True
 
256
        except StopIteration:
 
257
            # No changes
 
258
            return False
 
259
 
 
260
    @needs_read_lock
 
261
    def check_changed_or_out_of_date(self, strict, opt_name,
 
262
                                     more_error, more_warning):
 
263
        """Check the tree for uncommitted changes and branch synchronization.
 
264
 
 
265
        If strict is None and not set in the config files, a warning is issued.
 
266
        If strict is True, an error is raised.
 
267
        If strict is False, no checks are done and no warning is issued.
 
268
 
 
269
        :param strict: True, False or None, searched in branch config if None.
 
270
 
 
271
        :param opt_name: strict option name to search in config file.
 
272
 
 
273
        :param more_error: Details about how to avoid the check.
 
274
 
 
275
        :param more_warning: Details about what is happening.
 
276
        """
 
277
        if strict is None:
 
278
            strict = self.branch.get_config().get_user_option_as_bool(opt_name)
 
279
        if strict is not False:
 
280
            err_class = None
 
281
            if (self.has_changes()):
 
282
                err_class = errors.UncommittedChanges
 
283
            elif self.last_revision() != self.branch.last_revision():
 
284
                # The tree has lost sync with its branch, there is little
 
285
                # chance that the user is aware of it but he can still force
 
286
                # the action with --no-strict
 
287
                err_class = errors.OutOfDateTree
 
288
            if err_class is not None:
 
289
                if strict is None:
 
290
                    err = err_class(self, more=more_warning)
 
291
                    # We don't want to interrupt the user if he expressed no
 
292
                    # preference about strict.
 
293
                    trace.warning('%s', err._format())
 
294
                else:
 
295
                    err = err_class(self, more=more_error)
 
296
                    raise err
 
297
 
 
298
    @needs_read_lock
236
299
    def last_revision(self):
237
300
        """Return the revision id of the last commit performed in this tree.
238
301
 
355
418
 
356
419
        if not file_list:
357
420
            # no paths supplied: add the entire tree.
 
421
            # FIXME: this assumes we are running in a working tree subdir :-/
 
422
            # -- vila 20100208
358
423
            file_list = [u'.']
359
424
        # mutter("smart add of %r")
360
425
        inv = self.inventory
362
427
        ignored = {}
363
428
        dirs_to_add = []
364
429
        user_dirs = set()
 
430
        conflicts_related = set()
 
431
        # Not all mutable trees can have conflicts
 
432
        if getattr(self, 'conflicts', None) is not None:
 
433
            # Collect all related files without checking whether they exist or
 
434
            # are versioned. It's cheaper to do that once for all conflicts
 
435
            # than trying to find the relevant conflict for each added file.
 
436
            for c in self.conflicts():
 
437
                conflicts_related.update(c.associated_filenames())
365
438
 
366
439
        # validate user file paths and convert all paths to tree
367
440
        # relative : it's cheaper to make a tree relative path an abspath
369
442
        # perform the canonicalization in bulk.
370
443
        for filepath in osutils.canonical_relpaths(self.basedir, file_list):
371
444
            rf = _FastPath(filepath)
372
 
            # validate user parameters. Our recursive code avoids adding new files
373
 
            # that need such validation
 
445
            # validate user parameters. Our recursive code avoids adding new
 
446
            # files that need such validation
374
447
            if self.is_control_filename(rf.raw_path):
375
448
                raise errors.ForbiddenControlFileError(filename=rf.raw_path)
376
449
 
382
455
            else:
383
456
                if not InventoryEntry.versionable_kind(kind):
384
457
                    raise errors.BadFileKindError(filename=abspath, kind=kind)
385
 
            # ensure the named path is added, so that ignore rules in the later directory
386
 
            # walk dont skip it.
387
 
            # we dont have a parent ie known yet.: use the relatively slower inventory
388
 
            # probing method
 
458
            # ensure the named path is added, so that ignore rules in the later
 
459
            # directory walk dont skip it.
 
460
            # we dont have a parent ie known yet.: use the relatively slower
 
461
            # inventory probing method
389
462
            versioned = inv.has_filename(rf.raw_path)
390
463
            if versioned:
391
464
                continue
407
480
                dirs_to_add.append((path, None))
408
481
            prev_dir = path.raw_path
409
482
 
 
483
        illegalpath_re = re.compile(r'[\r\n]')
410
484
        # dirs_to_add is initialised to a list of directories, but as we scan
411
485
        # directories we append files to it.
412
486
        # XXX: We should determine kind of files when we scan them rather than
421
495
            kind = osutils.file_kind(abspath)
422
496
 
423
497
            if not InventoryEntry.versionable_kind(kind):
424
 
                warning("skipping %s (can't add file of kind '%s')", abspath, kind)
 
498
                trace.warning("skipping %s (can't add file of kind '%s')",
 
499
                              abspath, kind)
 
500
                continue
 
501
            if illegalpath_re.search(directory.raw_path):
 
502
                trace.warning("skipping %r (contains \\n or \\r)" % abspath)
 
503
                continue
 
504
            if directory.raw_path in conflicts_related:
 
505
                # If the file looks like one generated for a conflict, don't
 
506
                # add it.
 
507
                trace.warning(
 
508
                    'skipping %s (generated to help resolve conflicts)',
 
509
                    abspath)
425
510
                continue
426
511
 
427
512
            if parent_ie is not None:
450
535
                pass
451
536
                # mutter("%r is already versioned", abspath)
452
537
            elif sub_tree:
453
 
                # XXX: This is wrong; people *might* reasonably be trying to add
454
 
                # subtrees as subtrees.  This should probably only be done in formats
455
 
                # which can represent subtrees, and even then perhaps only when
456
 
                # the user asked to add subtrees.  At the moment you can add them
457
 
                # specially through 'join --reference', which is perhaps
458
 
                # reasonable: adding a new reference is a special operation and
459
 
                # can have a special behaviour.  mbp 20070306
460
 
                mutter("%r is a nested bzr tree", abspath)
 
538
                # XXX: This is wrong; people *might* reasonably be trying to
 
539
                # add subtrees as subtrees.  This should probably only be done
 
540
                # in formats which can represent subtrees, and even then
 
541
                # perhaps only when the user asked to add subtrees.  At the
 
542
                # moment you can add them specially through 'join --reference',
 
543
                # which is perhaps reasonable: adding a new reference is a
 
544
                # special operation and can have a special behaviour.  mbp
 
545
                # 20070306
 
546
                trace.mutter("%r is a nested bzr tree", abspath)
461
547
            else:
462
548
                _add_one(self, inv, parent_ie, directory, kind, action)
463
549
                added.append(directory.raw_path)
470
556
                    # without the parent ie, use the relatively slower inventory
471
557
                    # probing method
472
558
                    this_id = inv.path2id(
473
 
                            self._fix_case_of_inventory_path(directory.raw_path))
 
559
                        self._fix_case_of_inventory_path(directory.raw_path))
474
560
                    if this_id is None:
475
561
                        this_ie = None
476
562
                    else:
485
571
                    # faster - its impossible for a non root dir to have a
486
572
                    # control file.
487
573
                    if self.is_control_filename(subp):
488
 
                        mutter("skip control directory %r", subp)
 
574
                        trace.mutter("skip control directory %r", subp)
489
575
                    elif subf in this_ie.children:
490
576
                        # recurse into this already versioned subdir.
491
577
                        dirs_to_add.append((_FastPath(subp, subf), this_ie))
547
633
        inventory = basis.inventory._get_mutable_inventory()
548
634
        basis.unlock()
549
635
        inventory.apply_delta(delta)
550
 
        rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
 
636
        rev_tree = revisiontree.RevisionTree(self.branch.repository,
 
637
                                             inventory, new_revid)
551
638
        self.set_parent_trees([(new_revid, rev_tree)])
552
639
 
553
640
 
564
651
        self.create_hook(hooks.HookPoint('start_commit',
565
652
            "Called before a commit is performed on a tree. The start commit "
566
653
            "hook is able to change the tree before the commit takes place. "
567
 
            "start_commit is called with the bzrlib.tree.MutableTree that the "
568
 
            "commit is being performed on.", (1, 4), None))
 
654
            "start_commit is called with the bzrlib.mutabletree.MutableTree "
 
655
            "that the commit is being performed on.", (1, 4), None))
 
656
        self.create_hook(hooks.HookPoint('post_commit',
 
657
            "Called after a commit is performed on a tree. The hook is "
 
658
            "called with a bzrlib.mutabletree.PostCommitHookParams object. "
 
659
            "The mutable tree the commit was performed on is available via "
 
660
            "the mutable_tree attribute of that object.", (2, 0), None))
569
661
 
570
662
 
571
663
# install the default hooks into the MutableTree class.
572
664
MutableTree.hooks = MutableTreeHooks()
573
665
 
574
666
 
 
667
class PostCommitHookParams(object):
 
668
    """Parameters for the post_commit hook.
 
669
 
 
670
    To access the parameters, use the following attributes:
 
671
 
 
672
    * mutable_tree - the MutableTree object
 
673
    """
 
674
 
 
675
    def __init__(self, mutable_tree):
 
676
        """Create the parameters for the post_commit hook."""
 
677
        self.mutable_tree = mutable_tree
 
678
 
 
679
 
575
680
class _FastPath(object):
576
681
    """A path object with fast accessors for things like basename."""
577
682
 
618
723
        # there are a limited number of dirs we can be nested under, it should
619
724
        # generally find it very fast and not recurse after that.
620
725
        added = _add_one_and_parent(tree, inv, None,
621
 
            _FastPath(dirname(path.raw_path)), 'directory', action)
622
 
        parent_id = inv.path2id(dirname(path.raw_path))
 
726
            _FastPath(osutils.dirname(path.raw_path)), 'directory', action)
 
727
        parent_id = inv.path2id(osutils.dirname(path.raw_path))
623
728
        parent_ie = inv[parent_id]
624
729
    _add_one(tree, inv, parent_ie, path, kind, action)
625
730
    return added + [path.raw_path]