27
27
check_signatures=require|ignore|check-available(default)
28
28
create_signatures=always|never|when-required(default)
29
29
gpg_signing_command=name-of-program
30
log_format=name-of-format
31
in branches.conf, you specify the url of a branch and options for it.
32
in locations.conf, you specify the url of a branch and options for it.
32
33
Wildcards may be used - * and ? as normal in shell completion. Options
33
set in both bazaar.conf and branches.conf are overriden by the branches.conf
34
set in both bazaar.conf and locations.conf are overridden by the locations.conf
35
36
[/home/robertc/source]
36
37
recurse=False|True(default)
38
check_signatures= as abive
39
check_signatures= as above
39
40
create_signatures= as above.
41
42
explanation of options
48
49
create_signatures - this option controls whether bzr will always create
49
50
gpg signatures, never create them, or create them if the
50
51
branch is configured to require them.
51
NB: This option is planned, but not implemented yet.
52
log_format - this option sets the default log format. Possible values are
53
long, short, line, or a plugin can register new formats.
55
In bazaar.conf you can also define aliases in the ALIASES sections, example
58
lastlog=log --line -r-10..-1
59
ll=log --line -r-10..-1
54
from ConfigParser import ConfigParser
66
from fnmatch import fnmatch
56
from fnmatch import fnmatch
70
from StringIO import StringIO
61
import bzrlib.errors as errors
73
from bzrlib import errors, urlutils
74
from bzrlib.osutils import pathjoin
75
from bzrlib.trace import mutter, warning
76
import bzrlib.util.configobj.configobj as configobj
64
79
CHECK_IF_POSSIBLE=0
95
133
"""See gpg_signing_command()."""
136
def log_format(self):
137
"""What log format should be used"""
138
result = self._log_format()
143
def _log_format(self):
144
"""See log_format()."""
98
147
def __init__(self):
99
148
super(Config, self).__init__()
150
def post_commit(self):
151
"""An ordered list of python functions to call.
153
Each function takes branch, rev_id as parameters.
155
return self._post_commit()
157
def _post_commit(self):
158
"""See Config.post_commit."""
101
161
def user_email(self):
102
162
"""Return just the email component of a username."""
104
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
106
raise BzrError("%r doesn't seem to contain "
107
"a reasonable email address" % e)
163
return extract_email_address(self.username())
110
165
def username(self):
111
166
"""Return email-style username.
113
168
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
115
$BZREMAIL can be set to override this, then
170
$BZR_EMAIL can be set to override this (as well as the
171
deprecated $BZREMAIL), then
116
172
the concrete policy type is checked, and finally
118
but if none is found, a reasonable default is (hopefully)
174
If none is found, a reasonable default is (hopefully)
121
177
TODO: Check it's reasonably well-formed.
179
v = os.environ.get('BZR_EMAIL')
181
return v.decode(bzrlib.user_encoding)
123
182
v = os.environ.get('BZREMAIL')
184
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
125
185
return v.decode(bzrlib.user_encoding)
127
187
v = self._get_user_id()
146
206
return CHECK_IF_POSSIBLE
208
def signing_policy(self):
209
"""What is the current policy for signature checking?."""
210
policy = self._get_signing_policy()
211
if policy is not None:
213
return SIGN_WHEN_REQUIRED
148
215
def signature_needed(self):
149
216
"""Is a signature needed when committing ?."""
150
policy = self._get_signature_checking()
151
if policy == CHECK_ALWAYS:
217
policy = self._get_signing_policy()
219
policy = self._get_signature_checking()
220
if policy is not None:
221
warning("Please use create_signatures, not check_signatures "
222
"to set signing policy.")
223
if policy == CHECK_ALWAYS:
225
elif policy == SIGN_ALWAYS:
229
def get_alias(self, value):
230
return self._get_alias(value)
232
def _get_alias(self, value):
235
def get_nickname(self):
236
return self._get_nickname()
238
def _get_nickname(self):
156
242
class IniBasedConfig(Config):
157
243
"""A configuration policy that draws from ini files."""
174
262
def _get_signature_checking(self):
175
263
"""See Config._get_signature_checking."""
176
section = self._get_section()
179
if self._get_parser().has_option(section, 'check_signatures'):
180
return self._string_to_signature_policy(
181
self._get_parser().get(section, 'check_signatures'))
264
policy = self._get_user_option('check_signatures')
266
return self._string_to_signature_policy(policy)
268
def _get_signing_policy(self):
269
"""See Config._get_signing_policy"""
270
policy = self._get_user_option('create_signatures')
272
return self._string_to_signing_policy(policy)
183
274
def _get_user_id(self):
184
275
"""Get the user id from the 'email' key in the current section."""
185
section = self._get_section()
186
if section is not None:
187
if self._get_parser().has_option(section, 'email'):
188
return self._get_parser().get(section, 'email')
276
return self._get_user_option('email')
190
278
def _get_user_option(self, option_name):
191
279
"""See Config._get_user_option."""
192
section = self._get_section()
193
if section is not None:
194
if self._get_parser().has_option(section, option_name):
195
return self._get_parser().get(section, option_name)
281
return self._get_parser().get_value(self._get_section(),
197
286
def _gpg_signing_command(self):
198
287
"""See Config.gpg_signing_command."""
199
section = self._get_section()
200
if section is not None:
201
if self._get_parser().has_option(section, 'gpg_signing_command'):
202
return self._get_parser().get(section, 'gpg_signing_command')
288
return self._get_user_option('gpg_signing_command')
290
def _log_format(self):
291
"""See Config.log_format."""
292
return self._get_user_option('log_format')
204
294
def __init__(self, get_filename):
205
295
super(IniBasedConfig, self).__init__()
206
296
self._get_filename = get_filename
207
297
self._parser = None
299
def _post_commit(self):
300
"""See Config.post_commit."""
301
return self._get_user_option('post_commit')
209
303
def _string_to_signature_policy(self, signature_string):
210
304
"""Convert a string to a signing policy."""
217
311
raise errors.BzrError("Invalid signatures policy '%s'"
218
312
% signature_string)
314
def _string_to_signing_policy(self, signature_string):
315
"""Convert a string to a signing policy."""
316
if signature_string.lower() == 'when-required':
317
return SIGN_WHEN_REQUIRED
318
if signature_string.lower() == 'never':
320
if signature_string.lower() == 'always':
322
raise errors.BzrError("Invalid signing policy '%s'"
325
def _get_alias(self, value):
327
return self._get_parser().get_value("ALIASES",
332
def _get_nickname(self):
333
return self.get_user_option('nickname')
221
336
class GlobalConfig(IniBasedConfig):
222
337
"""The configuration that should be used for a specific location."""
224
339
def get_editor(self):
225
if self._get_parser().has_option(self._get_section(), 'editor'):
226
return self._get_parser().get(self._get_section(), 'editor')
340
return self._get_user_option('editor')
228
342
def __init__(self):
229
343
super(GlobalConfig, self).__init__(config_filename)
345
def set_user_option(self, option, value):
346
"""Save option and its value in the configuration."""
347
# FIXME: RBC 20051029 This should refresh the parser and also take a
348
# file lock on bazaar.conf.
349
conf_dir = os.path.dirname(self._get_filename())
350
ensure_config_dir_exists(conf_dir)
351
if 'DEFAULT' not in self._get_parser():
352
self._get_parser()['DEFAULT'] = {}
353
self._get_parser()['DEFAULT'][option] = value
354
f = open(self._get_filename(), 'wb')
355
self._get_parser().write(f)
232
359
class LocationConfig(IniBasedConfig):
233
360
"""A configuration object that gives the policy for a location."""
235
362
def __init__(self, location):
236
super(LocationConfig, self).__init__(branches_config_filename)
237
self._global_config = None
363
name_generator = locations_config_filename
364
if (not os.path.exists(name_generator()) and
365
os.path.exists(branches_config_filename())):
366
if sys.platform == 'win32':
367
warning('Please rename %s to %s'
368
% (branches_config_filename(),
369
locations_config_filename()))
371
warning('Please rename ~/.bazaar/branches.conf'
372
' to ~/.bazaar/locations.conf')
373
name_generator = branches_config_filename
374
super(LocationConfig, self).__init__(name_generator)
375
# local file locations are looked up by local path, rather than
376
# by file url. This is because the config file is a user
377
# file, and we would rather not expose the user to file urls.
378
if location.startswith('file://'):
379
location = urlutils.local_path_from_url(location)
238
380
self.location = location
240
def _get_global_config(self):
241
if self._global_config is None:
242
self._global_config = GlobalConfig()
243
return self._global_config
245
382
def _get_section(self):
246
383
"""Get the section we should look in for config items.
249
386
TODO: perhaps return a NullSection that thunks through to the
252
sections = self._get_parser().sections()
389
sections = self._get_parser()
253
390
location_names = self.location.split('/')
254
391
if self.location.endswith('/'):
255
392
del location_names[-1]
257
394
for section in sections:
258
section_names = section.split('/')
395
# location is a local path if possible, so we need
396
# to convert 'file://' urls to local paths if necessary.
397
# This also avoids having file:///path be a more exact
398
# match than '/path'.
399
if section.startswith('file://'):
400
section_path = urlutils.local_path_from_url(section)
402
section_path = section
403
section_names = section_path.split('/')
259
404
if section.endswith('/'):
260
405
del section_names[-1]
261
406
names = zip(location_names, section_names)
273
418
# if path is longer, and recurse is not true, no match
274
419
if len(section_names) < len(location_names):
275
if (self._get_parser().has_option(section, 'recurse')
276
and not self._get_parser().getboolean(section, 'recurse')):
421
if not self._get_parser()[section].as_bool('recurse'):
278
425
matches.append((len(section_names), section))
279
426
if not len(matches):
281
428
matches.sort(reverse=True)
282
429
return matches[0][1]
284
def _gpg_signing_command(self):
285
"""See Config.gpg_signing_command."""
286
command = super(LocationConfig, self)._gpg_signing_command()
287
if command is not None:
289
return self._get_global_config()._gpg_signing_command()
291
def _get_user_id(self):
292
user_id = super(LocationConfig, self)._get_user_id()
293
if user_id is not None:
295
return self._get_global_config()._get_user_id()
297
def _get_user_option(self, option_name):
298
"""See Config._get_user_option."""
299
option_value = super(LocationConfig,
300
self)._get_user_option(option_name)
301
if option_value is not None:
303
return self._get_global_config()._get_user_option(option_name)
305
def _get_signature_checking(self):
306
"""See Config._get_signature_checking."""
307
check = super(LocationConfig, self)._get_signature_checking()
308
if check is not None:
310
return self._get_global_config()._get_signature_checking()
431
def set_user_option(self, option, value):
432
"""Save option and its value in the configuration."""
433
# FIXME: RBC 20051029 This should refresh the parser and also take a
434
# file lock on locations.conf.
435
conf_dir = os.path.dirname(self._get_filename())
436
ensure_config_dir_exists(conf_dir)
437
location = self.location
438
if location.endswith('/'):
439
location = location[:-1]
440
if (not location in self._get_parser() and
441
not location + '/' in self._get_parser()):
442
self._get_parser()[location]={}
443
elif location + '/' in self._get_parser():
444
location = location + '/'
445
self._get_parser()[location][option]=value
446
self._get_parser().write(file(self._get_filename(), 'wb'))
313
449
class BranchConfig(Config):
314
450
"""A configuration object giving the policy for a branch."""
452
def _get_branch_data_config(self):
453
if self._branch_data_config is None:
454
self._branch_data_config = TreeConfig(self.branch)
455
return self._branch_data_config
316
457
def _get_location_config(self):
317
458
if self._location_config is None:
318
459
self._location_config = LocationConfig(self.branch.base)
319
460
return self._location_config
462
def _get_global_config(self):
463
if self._global_config is None:
464
self._global_config = GlobalConfig()
465
return self._global_config
467
def _get_best_value(self, option_name):
468
"""This returns a user option from local, tree or global config.
470
They are tried in that order. Use get_safe_value if trusted values
473
for source in self.option_sources:
474
value = getattr(source(), option_name)()
475
if value is not None:
479
def _get_safe_value(self, option_name):
480
"""This variant of get_best_value never returns untrusted values.
482
It does not return values from the branch data, because the branch may
483
not be controlled by the user.
485
We may wish to allow locations.conf to control whether branches are
486
trusted in the future.
488
for source in (self._get_location_config, self._get_global_config):
489
value = getattr(source(), option_name)()
490
if value is not None:
321
494
def _get_user_id(self):
322
495
"""Return the full user id for the branch.
325
498
This is looked up in the email controlfile for the branch.
328
return (self.branch.controlfile("email", "r")
501
return (self.branch.control_files.get_utf8("email")
330
503
.decode(bzrlib.user_encoding)
332
505
except errors.NoSuchFile, e:
335
return self._get_location_config()._get_user_id()
508
return self._get_best_value('_get_user_id')
337
510
def _get_signature_checking(self):
338
511
"""See Config._get_signature_checking."""
339
return self._get_location_config()._get_signature_checking()
512
return self._get_best_value('_get_signature_checking')
514
def _get_signing_policy(self):
515
"""See Config._get_signing_policy."""
516
return self._get_best_value('_get_signing_policy')
341
518
def _get_user_option(self, option_name):
342
519
"""See Config._get_user_option."""
343
return self._get_location_config()._get_user_option(option_name)
520
for source in self.option_sources:
521
value = source()._get_user_option(option_name)
522
if value is not None:
526
def set_user_option(self, name, value, local=False):
528
self._get_location_config().set_user_option(name, value)
530
self._get_branch_data_config().set_option(value, name)
345
533
def _gpg_signing_command(self):
346
534
"""See Config.gpg_signing_command."""
347
return self._get_location_config()._gpg_signing_command()
535
return self._get_safe_value('_gpg_signing_command')
349
537
def __init__(self, branch):
350
538
super(BranchConfig, self).__init__()
351
539
self._location_config = None
540
self._branch_data_config = None
541
self._global_config = None
352
542
self.branch = branch
543
self.option_sources = (self._get_location_config,
544
self._get_branch_data_config,
545
self._get_global_config)
547
def _post_commit(self):
548
"""See Config.post_commit."""
549
return self._get_safe_value('_post_commit')
551
def _get_nickname(self):
552
value = self._get_explicit_nickname()
553
if value is not None:
555
return self.branch.base.split('/')[-2]
557
def has_explicit_nickname(self):
558
"""Return true if a nickname has been explicitly assigned."""
559
return self._get_explicit_nickname() is not None
561
def _get_explicit_nickname(self):
562
return self._get_best_value('_get_nickname')
564
def _log_format(self):
565
"""See Config.log_format."""
566
return self._get_best_value('_log_format')
569
def ensure_config_dir_exists(path=None):
570
"""Make sure a configuration directory exists.
571
This makes sure that the directory exists.
572
On windows, since configuration directories are 2 levels deep,
573
it makes sure both the directory and the parent directory exists.
577
if not os.path.isdir(path):
578
if sys.platform == 'win32':
579
parent_dir = os.path.dirname(path)
580
if not os.path.isdir(parent_dir):
581
mutter('creating config parent directory: %r', parent_dir)
583
mutter('creating config directory: %r', path)
355
587
def config_dir():
360
592
TODO: Global option --config-dir to override this.
362
return os.path.join(os.path.expanduser("~"), ".bazaar")
594
base = os.environ.get('BZR_HOME', None)
595
if sys.platform == 'win32':
597
base = os.environ.get('APPDATA', None)
599
base = os.environ.get('HOME', None)
601
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
602
return pathjoin(base, 'bazaar', '2.0')
604
# cygwin, linux, and darwin all have a $HOME directory
606
base = os.path.expanduser("~")
607
return pathjoin(base, ".bazaar")
365
610
def config_filename():
366
611
"""Return per-user configuration ini file filename."""
367
return os.path.join(config_dir(), 'bazaar.conf')
612
return pathjoin(config_dir(), 'bazaar.conf')
370
615
def branches_config_filename():
371
616
"""Return per-user configuration ini file filename."""
372
return os.path.join(config_dir(), 'branches.conf')
617
return pathjoin(config_dir(), 'branches.conf')
620
def locations_config_filename():
621
"""Return per-user configuration ini file filename."""
622
return pathjoin(config_dir(), 'locations.conf')
625
def user_ignore_config_filename():
626
"""Return the user default ignore filename"""
627
return pathjoin(config_dir(), 'ignore')
375
630
def _auto_user_id():
392
647
uid = os.getuid()
393
648
w = pwd.getpwuid(uid)
394
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
395
username = w.pw_name.decode(bzrlib.user_encoding)
650
# we try utf-8 first, because on many variants (like Linux),
651
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
652
# false positives. (many users will have their user encoding set to
653
# latin-1, which cannot raise UnicodeError.)
655
gecos = w.pw_gecos.decode('utf-8')
659
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
660
encoding = bzrlib.user_encoding
662
raise errors.BzrCommandError('Unable to determine your name. '
663
'Use "bzr whoami" to set it.')
665
username = w.pw_name.decode(encoding)
667
raise errors.BzrCommandError('Unable to determine your name. '
668
'Use "bzr whoami" to set it.')
396
670
comma = gecos.find(',')
421
699
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
423
raise BzrError("%r doesn't seem to contain "
424
"a reasonable email address" % e)
701
raise errors.BzrError("%r doesn't seem to contain "
702
"a reasonable email address" % e)
425
703
return m.group(0)
706
class TreeConfig(IniBasedConfig):
707
"""Branch configuration data associated with its contents, not location"""
708
def __init__(self, branch):
711
def _get_parser(self, file=None):
713
return IniBasedConfig._get_parser(file)
714
return self._get_config()
716
def _get_config(self):
718
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
720
except errors.NoSuchFile:
721
obj = ConfigObj(encoding='utf=8')
724
def get_option(self, name, section=None, default=None):
725
self.branch.lock_read()
727
obj = self._get_config()
729
if section is not None:
738
def set_option(self, value, name, section=None):
739
"""Set a per-branch configuration option"""
740
self.branch.lock_write()
742
cfg_obj = self._get_config()
747
obj = cfg_obj[section]
749
cfg_obj[section] = {}
750
obj = cfg_obj[section]
752
out_file = StringIO()
753
cfg_obj.write(out_file)
755
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
