1
# Copyright (C) 2006-2010 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Development Ltd
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
13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Lists of ignore files, etc."""
28
from trace import warning
21
from bzrlib import config
23
# This was the full ignore list for bzr 0.8
24
# please keep these sorted (in C locale order) to aid merging
46
# Our setup tests dump .python-eggs in the bzr source tree root
60
'.sw[nop]', # vim editing nameless file
30
83
# ~/.bazaar/ignore will be filled out using
31
84
# this ignore list, if it does not exist
46
98
def parse_ignore_file(f):
47
"""Read in all of the lines in the file and turn it into an ignore list
49
Continue in the case of utf8 decoding errors, and emit a warning when
50
such and error is found. Optimise for the common case -- no decoding
54
ignore_file = f.read()
56
# Try and parse whole ignore file at once.
57
unicode_lines = ignore_file.decode('utf8').split('\n')
58
except UnicodeDecodeError:
59
# Otherwise go though line by line and pick out the 'good'
61
lines = ignore_file.split('\n')
63
for line_number, line in enumerate(lines):
65
unicode_lines.append(line.decode('utf-8'))
66
except UnicodeDecodeError:
67
# report error about line (idx+1)
68
warning('.bzrignore: On Line #%d, malformed utf8 character. '
69
'Ignoring line.' % (line_number+1))
71
# Append each line to ignore list if it's not a comment line
72
for line in unicode_lines:
99
"""Read in all of the lines in the file and turn it into an ignore list"""
101
for line in f.read().decode('utf8').split('\n'):
73
102
line = line.rstrip('\r\n')
74
103
if not line or line.startswith('#'):
76
ignored.add(globbing.normalize_pattern(line))
80
109
def get_user_ignores():
81
110
"""Get the list of user ignored files, possibly creating it."""
82
111
path = config.user_ignore_config_filename()
83
patterns = set(USER_DEFAULTS)
112
patterns = USER_DEFAULTS[:]
85
114
f = open(path, 'rb')
86
115
except (IOError, OSError), e:
92
121
# We want to ignore if we can't write to the file
93
122
# since get_* should be a safe operation
95
_set_user_ignores(USER_DEFAULTS)
124
set_user_ignores(USER_DEFAULTS)
96
125
except (IOError, OSError), e:
97
126
if e.errno not in (errno.EPERM,):
107
def _set_user_ignores(patterns):
136
def set_user_ignores(patterns):
108
137
"""Fill out the user ignore file with the given patterns
110
139
This may raise an error if it doesn't have permission to
111
140
write to the user ignore file.
112
This is mostly used for testing, since it would be
113
bad form to rewrite a user's ignore list.
114
bzrlib only writes this file if it does not exist.
116
142
ignore_path = config.user_ignore_config_filename()
117
143
config.ensure_config_dir_exists()
131
157
:param new_ignores: A list of ignore patterns
132
158
:return: The list of ignores that were added
134
ignored = get_user_ignores()
160
ignored = set(get_user_ignores())
136
162
for ignore in new_ignores:
137
ignore = globbing.normalize_pattern(ignore)
138
163
if ignore not in ignored:
139
164
ignored.add(ignore)
140
165
to_add.append(ignore)
155
_runtime_ignores = set()
158
def add_runtime_ignores(ignores):
159
"""Add some ignore patterns that only exists in memory.
161
This is used by some plugins that want bzr to ignore files,
162
but don't want to change a users ignore list.
163
(Such as a conversion script that needs to ignore temporary files,
164
but does not want to modify the project's ignore list.)
166
:param ignores: A list or generator of ignore patterns.
169
global _runtime_ignores
170
_runtime_ignores.update(set(ignores))
173
def get_runtime_ignores():
174
"""Get the current set of runtime ignores."""
175
return _runtime_ignores
178
def tree_ignores_add_patterns(tree, name_pattern_list):
179
"""Add more ignore patterns to the ignore file in a tree.
180
If ignore file does not exist then it will be created.
181
The ignore file will be automatically added under version control.
183
:param tree: Working tree to update the ignore list.
185
ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
186
if tree.has_filename(ifn):
189
igns = f.read().decode('utf-8')
195
# TODO: If the file already uses crlf-style termination, maybe
196
# we should use that for the newly added lines?
198
if igns and igns[-1] != '\n':
200
for name_pattern in name_pattern_list:
201
igns += name_pattern + '\n'
203
f = atomicfile.AtomicFile(ifn, 'wb')
205
f.write(igns.encode('utf-8'))
210
if not tree.path2id(bzrlib.IGNORE_FILENAME):
211
tree.add([bzrlib.IGNORE_FILENAME])