1
# Copyright (C) 2006-2011 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical 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."""
19
from __future__ import absolute_import
25
from .lazy_import import lazy_import
26
lazy_import(globals(), """
34
from breezy.sixish import (
26
# This was the full ignore list for bzr 0.8
27
# please keep these sorted (in C locale order) to aid merging
49
# Our setup tests dump .python-eggs in the bzr source tree root
63
'.sw[nop]', # vim editing nameless file
38
86
# ~/.bazaar/ignore will be filled out using
39
87
# this ignore list, if it does not exist
56
101
def parse_ignore_file(f):
57
"""Read in all of the lines in the file and turn it into an ignore list
59
Continue in the case of utf8 decoding errors, and emit a warning when
60
such and error is found. Optimise for the common case -- no decoding
102
"""Read in all of the lines in the file and turn it into an ignore list"""
64
ignore_file = f.read()
66
# Try and parse whole ignore file at once.
67
unicode_lines = ignore_file.decode('utf8').split('\n')
68
except UnicodeDecodeError:
69
# Otherwise go though line by line and pick out the 'good'
71
lines = ignore_file.split(b'\n')
73
for line_number, line in enumerate(lines):
75
unicode_lines.append(line.decode('utf-8'))
76
except UnicodeDecodeError:
77
# report error about line (idx+1)
79
'.bzrignore: On Line #%d, malformed utf8 character. '
80
'Ignoring line.' % (line_number+1))
82
# Append each line to ignore list if it's not a comment line
83
for line in unicode_lines:
104
for line in f.read().decode('utf8').split('\n'):
84
105
line = line.rstrip('\r\n')
85
106
if not line or line.startswith('#'):
94
115
patterns = set(USER_DEFAULTS)
96
117
f = open(path, 'rb')
97
except (IOError, OSError) as e:
118
except (IOError, OSError), e:
98
119
# open() shouldn't return an IOError without errno, but just in case
99
120
err = getattr(e, 'errno', None)
100
121
if err not in (errno.ENOENT,):
104
125
# since get_* should be a safe operation
106
127
_set_user_ignores(USER_DEFAULTS)
107
except (IOError, OSError) as e:
128
except (IOError, OSError), e:
108
129
if e.errno not in (errno.EPERM,):
122
143
write to the user ignore file.
123
144
This is mostly used for testing, since it would be
124
145
bad form to rewrite a user's ignore list.
125
breezy only writes this file if it does not exist.
146
bzrlib only writes this file if it does not exist.
127
148
ignore_path = config.user_ignore_config_filename()
128
149
config.ensure_config_dir_exists()
130
151
# Create an empty file
131
with open(ignore_path, 'wb') as f:
152
f = open(ignore_path, 'wb')
132
154
for pattern in patterns:
133
f.write(pattern.encode('utf8') + b'\n')
155
f.write(pattern.encode('utf8') + '\n')
136
160
def add_unique_user_ignores(new_ignores):
153
with open(config.user_ignore_config_filename(), 'ab') as f:
177
f = open(config.user_ignore_config_filename(), 'ab')
154
179
for pattern in to_add:
155
f.write(pattern.encode('utf8') + b'\n')
180
f.write(pattern.encode('utf8') + '\n')
178
205
def get_runtime_ignores():
179
206
"""Get the current set of runtime ignores."""
180
207
return _runtime_ignores
183
def tree_ignores_add_patterns(tree, name_pattern_list):
184
"""Add more ignore patterns to the ignore file in a tree.
185
If ignore file does not exist then it will be created.
186
The ignore file will be automatically added under version control.
188
:param tree: Working tree to update the ignore list.
189
:param name_pattern_list: List of ignore patterns.
192
# read in the existing ignores set
193
ifn = tree.abspath(tree._format.ignore_filename)
194
if tree.has_filename(ifn):
195
with open(ifn, 'rbU') as f:
196
file_contents = f.read()
197
# figure out what kind of line endings are used
198
newline = getattr(f, 'newlines', None)
199
if isinstance(newline, tuple):
201
elif newline is None:
202
newline = os.linesep.encode()
205
newline = os.linesep.encode()
207
sio = BytesIO(file_contents)
209
ignores = parse_ignore_file(sio)
213
# write out the updated ignores set
214
f = atomicfile.AtomicFile(ifn, 'wb')
216
# write the original contents, preserving original line endings
217
f.write(newline.join(file_contents.split(b'\n')))
218
if len(file_contents) > 0 and not file_contents.endswith(b'\n'):
220
for pattern in name_pattern_list:
221
if not pattern in ignores:
222
f.write(pattern.encode('utf-8'))
228
if not tree.is_versioned(tree._format.ignore_filename):
229
tree.add([tree._format.ignore_filename])