/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/ignores.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/ignores.py
 
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
"""Lists of ignore files, etc."""
 
18
 
 
19
import errno
 
20
from io import BytesIO
 
21
import os
 
22
 
 
23
import breezy
 
24
from .lazy_import import lazy_import
 
25
lazy_import(globals(), """
 
26
from breezy import (
 
27
    atomicfile,
 
28
    globbing,
 
29
    trace,
 
30
    )
 
31
""")
 
32
from . import (
 
33
    bedding,
 
34
    )
 
35
 
 
36
# ~/.config/breezy/ignore will be filled out using
 
37
# this ignore list, if it does not exist
 
38
# please keep these sorted (in C locale order) to aid merging
 
39
USER_DEFAULTS = [
 
40
    '*.a',
 
41
    '*.o',
 
42
    '*.py[co]',
 
43
    '*.so',
 
44
    '*.sw[nop]',
 
45
    '*~',
 
46
    '.#*',
 
47
    '[#]*#',
 
48
    '__pycache__',
 
49
    'bzr-orphans',
 
50
]
 
51
 
 
52
 
 
53
def parse_ignore_file(f):
 
54
    """Read in all of the lines in the file and turn it into an ignore list
 
55
 
 
56
    Continue in the case of utf8 decoding errors, and emit a warning when
 
57
    such and error is found. Optimise for the common case -- no decoding
 
58
    errors.
 
59
    """
 
60
    ignored = set()
 
61
    ignore_file = f.read()
 
62
    try:
 
63
        # Try and parse whole ignore file at once.
 
64
        unicode_lines = ignore_file.decode('utf8').split('\n')
 
65
    except UnicodeDecodeError:
 
66
        # Otherwise go though line by line and pick out the 'good'
 
67
        # decodable lines
 
68
        lines = ignore_file.split(b'\n')
 
69
        unicode_lines = []
 
70
        for line_number, line in enumerate(lines):
 
71
            try:
 
72
                unicode_lines.append(line.decode('utf-8'))
 
73
            except UnicodeDecodeError:
 
74
                # report error about line (idx+1)
 
75
                trace.warning(
 
76
                    '.bzrignore: On Line #%d, malformed utf8 character. '
 
77
                    'Ignoring line.' % (line_number + 1))
 
78
 
 
79
    # Append each line to ignore list if it's not a comment line
 
80
    for line in unicode_lines:
 
81
        line = line.rstrip('\r\n')
 
82
        if not line or line.startswith('#'):
 
83
            continue
 
84
        ignored.add(globbing.normalize_pattern(line))
 
85
    return ignored
 
86
 
 
87
 
 
88
def get_user_ignores():
 
89
    """Get the list of user ignored files, possibly creating it."""
 
90
    path = bedding.user_ignore_config_path()
 
91
    patterns = set(USER_DEFAULTS)
 
92
    try:
 
93
        f = open(path, 'rb')
 
94
    except (IOError, OSError) as e:
 
95
        # open() shouldn't return an IOError without errno, but just in case
 
96
        err = getattr(e, 'errno', None)
 
97
        if err not in (errno.ENOENT,):
 
98
            raise
 
99
        # Create the ignore file, and just return the default
 
100
        # We want to ignore if we can't write to the file
 
101
        # since get_* should be a safe operation
 
102
        try:
 
103
            _set_user_ignores(USER_DEFAULTS)
 
104
        except EnvironmentError as e:
 
105
            if e.errno not in (errno.EPERM, errno.ENOENT):
 
106
                raise
 
107
        return patterns
 
108
 
 
109
    try:
 
110
        return parse_ignore_file(f)
 
111
    finally:
 
112
        f.close()
 
113
 
 
114
 
 
115
def _set_user_ignores(patterns):
 
116
    """Fill out the user ignore file with the given patterns
 
117
 
 
118
    This may raise an error if it doesn't have permission to
 
119
    write to the user ignore file.
 
120
    This is mostly used for testing, since it would be
 
121
    bad form to rewrite a user's ignore list.
 
122
    breezy only writes this file if it does not exist.
 
123
    """
 
124
    ignore_path = bedding.user_ignore_config_path()
 
125
    bedding.ensure_config_dir_exists()
 
126
 
 
127
    # Create an empty file
 
128
    with open(ignore_path, 'wb') as f:
 
129
        for pattern in patterns:
 
130
            f.write(pattern.encode('utf8') + b'\n')
 
131
 
 
132
 
 
133
def add_unique_user_ignores(new_ignores):
 
134
    """Add entries to the user's ignore list if not present.
 
135
 
 
136
    :param new_ignores: A list of ignore patterns
 
137
    :return: The list of ignores that were added
 
138
    """
 
139
    ignored = get_user_ignores()
 
140
    to_add = []
 
141
    for ignore in new_ignores:
 
142
        ignore = globbing.normalize_pattern(ignore)
 
143
        if ignore not in ignored:
 
144
            ignored.add(ignore)
 
145
            to_add.append(ignore)
 
146
 
 
147
    if not to_add:
 
148
        return []
 
149
 
 
150
    with open(bedding.user_ignore_config_path(), 'ab') as f:
 
151
        for pattern in to_add:
 
152
            f.write(pattern.encode('utf8') + b'\n')
 
153
 
 
154
    return to_add
 
155
 
 
156
 
 
157
_runtime_ignores = set()
 
158
 
 
159
 
 
160
def add_runtime_ignores(ignores):
 
161
    """Add some ignore patterns that only exists in memory.
 
162
 
 
163
    This is used by some plugins that want bzr to ignore files,
 
164
    but don't want to change a users ignore list.
 
165
    (Such as a conversion script that needs to ignore temporary files,
 
166
    but does not want to modify the project's ignore list.)
 
167
 
 
168
    :param ignores: A list or generator of ignore patterns.
 
169
    :return: None
 
170
    """
 
171
    global _runtime_ignores
 
172
    _runtime_ignores.update(set(ignores))
 
173
 
 
174
 
 
175
def get_runtime_ignores():
 
176
    """Get the current set of runtime ignores."""
 
177
    return _runtime_ignores
 
178
 
 
179
 
 
180
def tree_ignores_add_patterns(tree, name_pattern_list):
 
181
    """Add more ignore patterns to the ignore file in a tree.
 
182
    If ignore file does not exist then it will be created.
 
183
    The ignore file will be automatically added under version control.
 
184
 
 
185
    :param tree: Working tree to update the ignore list.
 
186
    :param name_pattern_list: List of ignore patterns.
 
187
    :return: None
 
188
    """
 
189
    # read in the existing ignores set
 
190
    ifn = tree.abspath(tree._format.ignore_filename)
 
191
    if tree.has_filename(ifn):
 
192
        with open(ifn, 'rb') as f:
 
193
            file_contents = f.read()
 
194
            if file_contents.find(b'\r\n') != -1:
 
195
                newline = b'\r\n'
 
196
            else:
 
197
                newline = b'\n'
 
198
    else:
 
199
        file_contents = b""
 
200
        newline = os.linesep.encode()
 
201
 
 
202
    with BytesIO(file_contents) as sio:
 
203
        ignores = parse_ignore_file(sio)
 
204
 
 
205
    # write out the updated ignores set
 
206
    with atomicfile.AtomicFile(ifn, 'wb') as f:
 
207
        # write the original contents, preserving original line endings
 
208
        f.write(file_contents)
 
209
        if len(file_contents) > 0 and not file_contents.endswith(b'\n'):
 
210
            f.write(newline)
 
211
        for pattern in name_pattern_list:
 
212
            if pattern not in ignores:
 
213
                f.write(pattern.encode('utf-8'))
 
214
                f.write(newline)
 
215
 
 
216
    if not tree.is_versioned(tree._format.ignore_filename):
 
217
        tree.add([tree._format.ignore_filename])