1
# Copyright (C) 2006-2010 Canonical Ltd
1
# Copyright (C) 2006-2011 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
17
17
"""Lists of ignore files, etc."""
19
from __future__ import absolute_import
22
from io import BytesIO
26
from .lazy_import import lazy_import
27
lazy_import(globals(), """
28
from trace import warning
30
36
# ~/.bazaar/ignore will be filled out using
31
37
# this ignore list, if it does not exist
46
53
def parse_ignore_file(f):
47
54
"""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
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
65
except UnicodeDecodeError:
59
66
# Otherwise go though line by line and pick out the 'good'
61
lines = ignore_file.split('\n')
68
lines = ignore_file.split(b'\n')
63
70
for line_number, line in enumerate(lines):
65
72
unicode_lines.append(line.decode('utf-8'))
66
73
except UnicodeDecodeError:
67
74
# report error about line (idx+1)
68
warning('.bzrignore: On Line #%d, malformed utf8 character. '
69
'Ignoring line.' % (line_number+1))
76
'.bzrignore: On Line #%d, malformed utf8 character. '
77
'Ignoring line.' % (line_number + 1))
71
79
# Append each line to ignore list if it's not a comment line
72
80
for line in unicode_lines:
83
91
patterns = set(USER_DEFAULTS)
85
93
f = open(path, 'rb')
86
except (IOError, OSError), e:
94
except (IOError, OSError) as e:
87
95
# open() shouldn't return an IOError without errno, but just in case
88
96
err = getattr(e, 'errno', None)
89
97
if err not in (errno.ENOENT,):
93
101
# since get_* should be a safe operation
95
103
_set_user_ignores(USER_DEFAULTS)
96
except (IOError, OSError), e:
104
except (IOError, OSError) as e:
97
105
if e.errno not in (errno.EPERM,):
111
119
write to the user ignore file.
112
120
This is mostly used for testing, since it would be
113
121
bad form to rewrite a user's ignore list.
114
bzrlib only writes this file if it does not exist.
122
breezy only writes this file if it does not exist.
116
124
ignore_path = config.user_ignore_config_filename()
117
125
config.ensure_config_dir_exists()
119
127
# Create an empty file
120
f = open(ignore_path, 'wb')
128
with open(ignore_path, 'wb') as f:
122
129
for pattern in patterns:
123
f.write(pattern.encode('utf8') + '\n')
130
f.write(pattern.encode('utf8') + b'\n')
128
133
def add_unique_user_ignores(new_ignores):
145
f = open(config.user_ignore_config_filename(), 'ab')
150
with open(config.user_ignore_config_filename(), 'ab') as f:
147
151
for pattern in to_add:
148
f.write(pattern.encode('utf8') + '\n')
152
f.write(pattern.encode('utf8') + b'\n')
181
183
The ignore file will be automatically added under version control.
183
185
:param tree: Working tree to update the ignore list.
186
:param name_pattern_list: List of ignore patterns.
185
ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
189
# read in the existing ignores set
190
ifn = tree.abspath(tree._format.ignore_filename)
186
191
if tree.has_filename(ifn):
189
igns = f.read().decode('utf-8')
192
with open(ifn, 'rb') as f:
193
file_contents = f.read()
194
if file_contents.find(b'\r\n') != -1:
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])
200
newline = os.linesep.encode()
202
with BytesIO(file_contents) as sio:
203
ignores = parse_ignore_file(sio)
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'):
211
for pattern in name_pattern_list:
212
if pattern not in ignores:
213
f.write(pattern.encode('utf-8'))
216
if not tree.is_versioned(tree._format.ignore_filename):
217
tree.add([tree._format.ignore_filename])