← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ignores.py

  • Committer: Aaron Bentley
  • Date: 2005-09-30 04:02:34 UTC
  • mfrom: (1185.12.1)
  • mto: (1393.1.21) (1185.14.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: aaron.bentley@utoronto.ca-20050930040234-71c1a151f795e806
Merged export fix

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ignores.py
1
 
# Copyright (C) 2006-2010 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
 
import os
21
 
from cStringIO import StringIO
22
 
 
23
 
import bzrlib
24
 
from bzrlib import (
25
 
    atomicfile,
26
 
    config,
27
 
    globbing,
28
 
    )
29
 
 
30
 
from trace import warning
31
 
 
32
 
# ~/.bazaar/ignore will be filled out using
33
 
# this ignore list, if it does not exist
34
 
# please keep these sorted (in C locale order) to aid merging
35
 
USER_DEFAULTS = [
36
 
    '*.a',
37
 
    '*.o',
38
 
    '*.py[co]',
39
 
    '*.so',
40
 
    '*.sw[nop]',
41
 
    '*~',
42
 
    '.#*',
43
 
    '[#]*#',
44
 
]
45
 
 
46
 
 
47
 
 
48
 
def parse_ignore_file(f):
49
 
    """Read in all of the lines in the file and turn it into an ignore list
50
 
    
51
 
    Continue in the case of utf8 decoding errors, and emit a warning when 
52
 
    such and error is found. Optimise for the common case -- no decoding 
53
 
    errors.
54
 
    """
55
 
    ignored = set()
56
 
    ignore_file = f.read()
57
 
    try:
58
 
        # Try and parse whole ignore file at once.
59
 
        unicode_lines = ignore_file.decode('utf8').split('\n')
60
 
    except UnicodeDecodeError:
61
 
        # Otherwise go though line by line and pick out the 'good'
62
 
        # decodable lines
63
 
        lines = ignore_file.split('\n')
64
 
        unicode_lines = []
65
 
        for line_number, line in enumerate(lines):
66
 
            try:
67
 
                unicode_lines.append(line.decode('utf-8'))
68
 
            except UnicodeDecodeError:
69
 
                # report error about line (idx+1)
70
 
                warning('.bzrignore: On Line #%d, malformed utf8 character. '
71
 
                        'Ignoring line.' % (line_number+1))
72
 
 
73
 
    # Append each line to ignore list if it's not a comment line
74
 
    for line in unicode_lines:
75
 
        line = line.rstrip('\r\n')
76
 
        if not line or line.startswith('#'):
77
 
            continue
78
 
        ignored.add(globbing.normalize_pattern(line))
79
 
    return ignored
80
 
 
81
 
 
82
 
def get_user_ignores():
83
 
    """Get the list of user ignored files, possibly creating it."""
84
 
    path = config.user_ignore_config_filename()
85
 
    patterns = set(USER_DEFAULTS)
86
 
    try:
87
 
        f = open(path, 'rb')
88
 
    except (IOError, OSError), e:
89
 
        # open() shouldn't return an IOError without errno, but just in case
90
 
        err = getattr(e, 'errno', None)
91
 
        if err not in (errno.ENOENT,):
92
 
            raise
93
 
        # Create the ignore file, and just return the default
94
 
        # We want to ignore if we can't write to the file
95
 
        # since get_* should be a safe operation
96
 
        try:
97
 
            _set_user_ignores(USER_DEFAULTS)
98
 
        except (IOError, OSError), e:
99
 
            if e.errno not in (errno.EPERM,):
100
 
                raise
101
 
        return patterns
102
 
 
103
 
    try:
104
 
        return parse_ignore_file(f)
105
 
    finally:
106
 
        f.close()
107
 
 
108
 
 
109
 
def _set_user_ignores(patterns):
110
 
    """Fill out the user ignore file with the given patterns
111
 
 
112
 
    This may raise an error if it doesn't have permission to
113
 
    write to the user ignore file.
114
 
    This is mostly used for testing, since it would be
115
 
    bad form to rewrite a user's ignore list.
116
 
    bzrlib only writes this file if it does not exist.
117
 
    """
118
 
    ignore_path = config.user_ignore_config_filename()
119
 
    config.ensure_config_dir_exists()
120
 
 
121
 
    # Create an empty file
122
 
    f = open(ignore_path, 'wb')
123
 
    try:
124
 
        for pattern in patterns:
125
 
            f.write(pattern.encode('utf8') + '\n')
126
 
    finally:
127
 
        f.close()
128
 
 
129
 
 
130
 
def add_unique_user_ignores(new_ignores):
131
 
    """Add entries to the user's ignore list if not present.
132
 
 
133
 
    :param new_ignores: A list of ignore patterns
134
 
    :return: The list of ignores that were added
135
 
    """
136
 
    ignored = get_user_ignores()
137
 
    to_add = []
138
 
    for ignore in new_ignores:
139
 
        ignore = globbing.normalize_pattern(ignore)
140
 
        if ignore not in ignored:
141
 
            ignored.add(ignore)
142
 
            to_add.append(ignore)
143
 
 
144
 
    if not to_add:
145
 
        return []
146
 
 
147
 
    f = open(config.user_ignore_config_filename(), 'ab')
148
 
    try:
149
 
        for pattern in to_add:
150
 
            f.write(pattern.encode('utf8') + '\n')
151
 
    finally:
152
 
        f.close()
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(bzrlib.IGNORE_FILENAME)
191
 
    if tree.has_filename(ifn):
192
 
        f = open(ifn, 'rU')
193
 
        try:
194
 
            file_contents = f.read()
195
 
            # figure out what kind of line endings are used
196
 
            newline = getattr(f, 'newlines', None)
197
 
            if type(newline) is tuple:
198
 
                newline = newline[0]
199
 
            elif newline is None:
200
 
                newline = os.linesep
201
 
        finally:
202
 
            f.close()
203
 
    else:
204
 
        file_contents = ""
205
 
        newline = os.linesep
206
 
    
207
 
    sio = StringIO(file_contents)
208
 
    try:
209
 
        ignores = parse_ignore_file(sio)
210
 
    finally:
211
 
        sio.close()
212
 
    
213
 
    # write out the updated ignores set
214
 
    f = atomicfile.AtomicFile(ifn, 'wb')
215
 
    try:
216
 
        # write the original contents, preserving original line endings
217
 
        f.write(newline.join(file_contents.split('\n')))
218
 
        if len(file_contents) > 0 and not file_contents.endswith('\n'):
219
 
            f.write(newline)
220
 
        for pattern in name_pattern_list:
221
 
            if not pattern in ignores:
222
 
                f.write(pattern.encode('utf-8'))
223
 
                f.write(newline)
224
 
        f.commit()
225
 
    finally:
226
 
        f.close()
227
 
 
228
 
    if not tree.path2id(bzrlib.IGNORE_FILENAME):
229
 
        tree.add([bzrlib.IGNORE_FILENAME])