/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 breezy/check.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/check.py
 
1
# Copyright (C) 2005, 2006 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
# TODO: Perhaps have a way to record errors other than by raising exceptions;
 
18
# would perhaps be enough to accumulate exception objects in a list without
 
19
# raising them.  If there's more than one exception it'd be good to see them
 
20
# all.
 
21
 
 
22
"""Checking of bzr objects.
 
23
 
 
24
check_refs is a concept used for optimising check. Objects that depend on other
 
25
objects (e.g. tree on repository) can list the objects they would be requesting
 
26
so that when the dependent object is checked, matches can be pulled out and
 
27
evaluated in-line rather than re-reading the same data many times.
 
28
check_refs are tuples (kind, value). Currently defined kinds are:
 
29
 
 
30
* 'trees', where value is a revid and the looked up objects are revision trees.
 
31
* 'lefthand-distance', where value is a revid and the looked up objects are the
 
32
  distance along the lefthand path to NULL for that revid.
 
33
* 'revision-existence', where value is a revid, and the result is True or False
 
34
  indicating that the revision was found/not found.
 
35
"""
 
36
 
 
37
import contextlib
 
38
 
 
39
from . import (
 
40
    errors,
 
41
    )
 
42
from .controldir import ControlDir
 
43
from .trace import note
 
44
from .i18n import gettext
 
45
 
 
46
 
 
47
class Check(object):
 
48
    """Check a repository"""
 
49
 
 
50
    def __init__(self, repository, check_repo=True):
 
51
        self.repository = repository
 
52
 
 
53
    def report_results(self, verbose):
 
54
        raise NotImplementedError(self.report_results)
 
55
 
 
56
 
 
57
def scan_branch(branch, needed_refs, exit_stack):
 
58
    """Scan a branch for refs.
 
59
 
 
60
    :param branch:  The branch to schedule for checking.
 
61
    :param needed_refs: Refs we are accumulating.
 
62
    :param exit_stack: The exit stack accumulating.
 
63
    """
 
64
    note(gettext("Checking branch at '%s'.") % (branch.base,))
 
65
    exit_stack.enter_context(branch.lock_read())
 
66
    branch_refs = branch._get_check_refs()
 
67
    for ref in branch_refs:
 
68
        reflist = needed_refs.setdefault(ref, [])
 
69
        reflist.append(branch)
 
70
 
 
71
 
 
72
def scan_tree(base_tree, tree, needed_refs, exit_stack):
 
73
    """Scan a tree for refs.
 
74
 
 
75
    :param base_tree: The original tree check opened, used to detect duplicate
 
76
        tree checks.
 
77
    :param tree:  The tree to schedule for checking.
 
78
    :param needed_refs: Refs we are accumulating.
 
79
    :param exit_stack: The exit stack accumulating.
 
80
    """
 
81
    if base_tree is not None and tree.basedir == base_tree.basedir:
 
82
        return
 
83
    note(gettext("Checking working tree at '%s'.") % (tree.basedir,))
 
84
    exit_stack.enter_context(tree.lock_read())
 
85
    tree_refs = tree._get_check_refs()
 
86
    for ref in tree_refs:
 
87
        reflist = needed_refs.setdefault(ref, [])
 
88
        reflist.append(tree)
 
89
 
 
90
 
 
91
def check_dwim(path, verbose, do_branch=False, do_repo=False, do_tree=False):
 
92
    """Check multiple objects.
 
93
 
 
94
    If errors occur they are accumulated and reported as far as possible, and
 
95
    an exception raised at the end of the process.
 
96
    """
 
97
    try:
 
98
        base_tree, branch, repo, relpath = \
 
99
            ControlDir.open_containing_tree_branch_or_repository(path)
 
100
    except errors.NotBranchError:
 
101
        base_tree = branch = repo = None
 
102
 
 
103
    with contextlib.ExitStack() as exit_stack:
 
104
        needed_refs = {}
 
105
        if base_tree is not None:
 
106
            # If the tree is a lightweight checkout we won't see it in
 
107
            # repo.find_branches - add now.
 
108
            if do_tree:
 
109
                scan_tree(None, base_tree, needed_refs, exit_stack)
 
110
            branch = base_tree.branch
 
111
        if branch is not None:
 
112
            # We have a branch
 
113
            if repo is None:
 
114
                # The branch is in a shared repository
 
115
                repo = branch.repository
 
116
        if repo is not None:
 
117
            exit_stack.enter_context(repo.lock_read())
 
118
            branches = list(repo.find_branches(using=True))
 
119
            saw_tree = False
 
120
            if do_branch or do_tree:
 
121
                for branch in branches:
 
122
                    if do_tree:
 
123
                        try:
 
124
                            tree = branch.controldir.open_workingtree()
 
125
                            saw_tree = True
 
126
                        except (errors.NotLocalUrl, errors.NoWorkingTree):
 
127
                            pass
 
128
                        else:
 
129
                            scan_tree(base_tree, tree, needed_refs, exit_stack)
 
130
                    if do_branch:
 
131
                        scan_branch(branch, needed_refs, exit_stack)
 
132
            if do_branch and not branches:
 
133
                note(gettext("No branch found at specified location."))
 
134
            if do_tree and base_tree is None and not saw_tree:
 
135
                note(gettext("No working tree found at specified location."))
 
136
            if do_repo or do_branch or do_tree:
 
137
                if do_repo:
 
138
                    note(gettext("Checking repository at '%s'.")
 
139
                         % (repo.user_url,))
 
140
                result = repo.check(None, callback_refs=needed_refs,
 
141
                                    check_repo=do_repo)
 
142
                result.report_results(verbose)
 
143
        else:
 
144
            if do_tree:
 
145
                note(gettext("No working tree found at specified location."))
 
146
            if do_branch:
 
147
                note(gettext("No branch found at specified location."))
 
148
            if do_repo:
 
149
                note(gettext("No repository found at specified location."))