18
18
"""Configuration that affects the behaviour of Bazaar.
20
20
Currently this configuration resides in ~/.bazaar/bazaar.conf
21
and ~/.bazaar/locations.conf, which is written to by bzr.
21
and ~/.bazaar/branches.conf, which is written to by bzr.
23
In bazaar.conf the following options may be set:
23
In bazaar.config the following options may be set:
25
25
editor=name-of-program
26
26
email=Your Name <your@email.address>
27
27
check_signatures=require|ignore|check-available(default)
28
28
create_signatures=always|never|when-required(default)
29
gpg_signing_command=name-of-program
30
log_format=name-of-format
32
in locations.conf, you specify the url of a branch and options for it.
30
in branches.conf, you specify the url of a branch and options for it.
33
31
Wildcards may be used - * and ? as normal in shell completion. Options
34
set in both bazaar.conf and locations.conf are overridden by the locations.conf
32
set in both bazaar.conf and branches.conf are overriden by the branches.conf
36
34
[/home/robertc/source]
37
35
recurse=False|True(default)
39
check_signatures= as above
37
check_signatures= as abive
40
38
create_signatures= as above.
42
40
explanation of options
49
47
create_signatures - this option controls whether bzr will always create
50
48
gpg signatures, never create them, or create them if the
51
49
branch is configured to require them.
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
50
NB: This option is planned, but not implemented yet.
53
from ConfigParser import ConfigParser
67
from bzrlib.lazy_import import lazy_import
68
lazy_import(globals(), """
55
from fnmatch import fnmatch
70
from fnmatch import fnmatch
72
from StringIO import StringIO
82
import bzrlib.util.configobj.configobj as configobj
85
from bzrlib.trace import mutter, warning
60
import bzrlib.errors as errors
88
63
CHECK_IF_POSSIBLE=0
144
75
def _get_signature_checking(self):
145
76
"""Template method to override signature checking policy."""
147
def _get_signing_policy(self):
148
"""Template method to override signature creation policy."""
150
def _get_user_option(self, option_name):
151
"""Template method to provide a user option."""
154
def get_user_option(self, option_name):
155
"""Get a generic option - no special process, no default."""
156
return self._get_user_option(option_name)
158
def gpg_signing_command(self):
159
"""What program should be used to sign signatures?"""
160
result = self._gpg_signing_command()
165
def _gpg_signing_command(self):
166
"""See gpg_signing_command()."""
169
def log_format(self):
170
"""What log format should be used"""
171
result = self._log_format()
176
def _log_format(self):
177
"""See log_format()."""
180
78
def __init__(self):
181
79
super(Config, self).__init__()
183
def post_commit(self):
184
"""An ordered list of python functions to call.
186
Each function takes branch, rev_id as parameters.
188
return self._post_commit()
190
def _post_commit(self):
191
"""See Config.post_commit."""
194
81
def user_email(self):
195
82
"""Return just the email component of a username."""
196
return extract_email_address(self.username())
84
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
86
raise BzrError("%r doesn't seem to contain "
87
"a reasonable email address" % e)
198
90
def username(self):
199
91
"""Return email-style username.
201
93
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
203
$BZR_EMAIL can be set to override this (as well as the
204
deprecated $BZREMAIL), then
95
$BZREMAIL can be set to override this, then
205
96
the concrete policy type is checked, and finally
207
If none is found, a reasonable default is (hopefully)
98
but if none is found, a reasonable default is (hopefully)
210
101
TODO: Check it's reasonably well-formed.
212
v = os.environ.get('BZR_EMAIL')
214
return v.decode(bzrlib.user_encoding)
215
103
v = os.environ.get('BZREMAIL')
217
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
218
105
return v.decode(bzrlib.user_encoding)
220
107
v = self._get_user_id()
239
126
return CHECK_IF_POSSIBLE
241
def signing_policy(self):
242
"""What is the current policy for signature checking?."""
243
policy = self._get_signing_policy()
244
if policy is not None:
246
return SIGN_WHEN_REQUIRED
248
128
def signature_needed(self):
249
129
"""Is a signature needed when committing ?."""
250
policy = self._get_signing_policy()
252
policy = self._get_signature_checking()
253
if policy is not None:
254
warning("Please use create_signatures, not check_signatures "
255
"to set signing policy.")
256
if policy == CHECK_ALWAYS:
258
elif policy == SIGN_ALWAYS:
130
policy = self._get_signature_checking()
131
if policy == CHECK_ALWAYS:
262
def get_alias(self, value):
263
return self._get_alias(value)
265
def _get_alias(self, value):
268
def get_nickname(self):
269
return self._get_nickname()
271
def _get_nickname(self):
275
136
class IniBasedConfig(Config):
276
137
"""A configuration policy that draws from ini files."""
278
139
def _get_parser(self, file=None):
279
140
if self._parser is not None:
280
141
return self._parser
282
input = self._get_filename()
286
self._parser = ConfigObj(input, encoding='utf-8')
287
except configobj.ConfigObjError, e:
288
raise errors.ParseConfigError(e.errors, e.config.filename)
291
def _get_matching_sections(self):
292
"""Return an ordered list of (section_name, extra_path) pairs.
294
If the section contains inherited configuration, extra_path is
295
a string containing the additional path components.
297
section = self._get_section()
298
if section is not None:
299
return [(section, '')]
142
parser = ConfigParser()
146
parser.read([self._get_filename()])
147
self._parser = parser
303
150
def _get_section(self):
304
151
"""Override this to define the section used by the config."""
307
def _get_option_policy(self, section, option_name):
308
"""Return the policy for the given (section, option_name) pair."""
311
154
def _get_signature_checking(self):
312
155
"""See Config._get_signature_checking."""
313
policy = self._get_user_option('check_signatures')
315
return self._string_to_signature_policy(policy)
317
def _get_signing_policy(self):
318
"""See Config._get_signing_policy"""
319
policy = self._get_user_option('create_signatures')
321
return self._string_to_signing_policy(policy)
156
section = self._get_section()
159
if self._get_parser().has_option(section, 'check_signatures'):
160
return self._string_to_signature_policy(
161
self._get_parser().get(section, 'check_signatures'))
323
163
def _get_user_id(self):
324
164
"""Get the user id from the 'email' key in the current section."""
325
return self._get_user_option('email')
327
def _get_user_option(self, option_name):
328
"""See Config._get_user_option."""
329
for (section, extra_path) in self._get_matching_sections():
331
value = self._get_parser().get_value(section, option_name)
334
policy = self._get_option_policy(section, option_name)
335
if policy == POLICY_NONE:
337
elif policy == POLICY_NORECURSE:
338
# norecurse items only apply to the exact path
343
elif policy == POLICY_APPENDPATH:
345
value = urlutils.join(value, extra_path)
348
raise AssertionError('Unexpected config policy %r' % policy)
352
def _gpg_signing_command(self):
353
"""See Config.gpg_signing_command."""
354
return self._get_user_option('gpg_signing_command')
356
def _log_format(self):
357
"""See Config.log_format."""
358
return self._get_user_option('log_format')
165
section = self._get_section()
166
if section is not None:
167
if self._get_parser().has_option(section, 'email'):
168
return self._get_parser().get(section, 'email')
360
170
def __init__(self, get_filename):
361
171
super(IniBasedConfig, self).__init__()
362
172
self._get_filename = get_filename
363
173
self._parser = None
365
def _post_commit(self):
366
"""See Config.post_commit."""
367
return self._get_user_option('post_commit')
369
175
def _string_to_signature_policy(self, signature_string):
370
176
"""Convert a string to a signing policy."""
377
183
raise errors.BzrError("Invalid signatures policy '%s'"
378
184
% signature_string)
380
def _string_to_signing_policy(self, signature_string):
381
"""Convert a string to a signing policy."""
382
if signature_string.lower() == 'when-required':
383
return SIGN_WHEN_REQUIRED
384
if signature_string.lower() == 'never':
386
if signature_string.lower() == 'always':
388
raise errors.BzrError("Invalid signing policy '%s'"
391
def _get_alias(self, value):
393
return self._get_parser().get_value("ALIASES",
398
def _get_nickname(self):
399
return self.get_user_option('nickname')
402
187
class GlobalConfig(IniBasedConfig):
403
188
"""The configuration that should be used for a specific location."""
405
190
def get_editor(self):
406
return self._get_user_option('editor')
191
if self._get_parser().has_option(self._get_section(), 'editor'):
192
return self._get_parser().get(self._get_section(), 'editor')
408
194
def __init__(self):
409
195
super(GlobalConfig, self).__init__(config_filename)
411
def set_user_option(self, option, value):
412
"""Save option and its value in the configuration."""
413
# FIXME: RBC 20051029 This should refresh the parser and also take a
414
# file lock on bazaar.conf.
415
conf_dir = os.path.dirname(self._get_filename())
416
ensure_config_dir_exists(conf_dir)
417
if 'DEFAULT' not in self._get_parser():
418
self._get_parser()['DEFAULT'] = {}
419
self._get_parser()['DEFAULT'][option] = value
420
f = open(self._get_filename(), 'wb')
421
self._get_parser().write(f)
425
198
class LocationConfig(IniBasedConfig):
426
199
"""A configuration object that gives the policy for a location."""
428
201
def __init__(self, location):
429
name_generator = locations_config_filename
430
if (not os.path.exists(name_generator()) and
431
os.path.exists(branches_config_filename())):
432
if sys.platform == 'win32':
433
warning('Please rename %s to %s'
434
% (branches_config_filename(),
435
locations_config_filename()))
437
warning('Please rename ~/.bazaar/branches.conf'
438
' to ~/.bazaar/locations.conf')
439
name_generator = branches_config_filename
440
super(LocationConfig, self).__init__(name_generator)
441
# local file locations are looked up by local path, rather than
442
# by file url. This is because the config file is a user
443
# file, and we would rather not expose the user to file urls.
444
if location.startswith('file://'):
445
location = urlutils.local_path_from_url(location)
202
super(LocationConfig, self).__init__(branches_config_filename)
203
self._global_config = None
446
204
self.location = location
448
def _get_matching_sections(self):
449
"""Return an ordered list of section names matching this location."""
450
sections = self._get_parser()
206
def _get_global_config(self):
207
if self._global_config is None:
208
self._global_config = GlobalConfig()
209
return self._global_config
211
def _get_section(self):
212
"""Get the section we should look in for config items.
214
Returns None if none exists.
215
TODO: perhaps return a NullSection that thunks through to the
218
sections = self._get_parser().sections()
451
219
location_names = self.location.split('/')
452
220
if self.location.endswith('/'):
453
221
del location_names[-1]
455
223
for section in sections:
456
# location is a local path if possible, so we need
457
# to convert 'file://' urls to local paths if necessary.
458
# This also avoids having file:///path be a more exact
459
# match than '/path'.
460
if section.startswith('file://'):
461
section_path = urlutils.local_path_from_url(section)
463
section_path = section
464
section_names = section_path.split('/')
224
section_names = section.split('/')
465
225
if section.endswith('/'):
466
226
del section_names[-1]
467
227
names = zip(location_names, section_names)
476
236
# if section is longer, no match.
477
237
if len(section_names) > len(location_names):
479
matches.append((len(section_names), section,
480
'/'.join(location_names[len(section_names):])))
239
# if path is longer, and recurse is not true, no match
240
if len(section_names) < len(location_names):
241
if (self._get_parser().has_option(section, 'recurse')
242
and not self._get_parser().getboolean(section, 'recurse')):
244
matches.append((len(section_names), section))
481
247
matches.sort(reverse=True)
483
for (length, section, extra_path) in matches:
484
sections.append((section, extra_path))
485
# should we stop looking for parent configs here?
487
if self._get_parser()[section].as_bool('ignore_parents'):
493
def _get_option_policy(self, section, option_name):
494
"""Return the policy for the given (section, option_name) pair."""
495
# check for the old 'recurse=False' flag
497
recurse = self._get_parser()[section].as_bool('recurse')
501
return POLICY_NORECURSE
503
policy_key = option_name + ':policy'
505
policy_name = self._get_parser()[section][policy_key]
509
return _policy_value[policy_name]
511
def _set_option_policy(self, section, option_name, option_policy):
512
"""Set the policy for the given option name in the given section."""
513
# The old recurse=False option affects all options in the
514
# section. To handle multiple policies in the section, we
515
# need to convert it to a policy_norecurse key.
517
recurse = self._get_parser()[section].as_bool('recurse')
521
symbol_versioning.warn(
522
'The recurse option is deprecated as of 0.14. '
523
'The section "%s" has been converted to use policies.'
526
del self._get_parser()[section]['recurse']
528
for key in self._get_parser()[section].keys():
529
if not key.endswith(':policy'):
530
self._get_parser()[section][key +
531
':policy'] = 'norecurse'
533
policy_key = option_name + ':policy'
534
policy_name = _policy_name[option_policy]
535
if policy_name is not None:
536
self._get_parser()[section][policy_key] = policy_name
538
if policy_key in self._get_parser()[section]:
539
del self._get_parser()[section][policy_key]
541
def set_user_option(self, option, value, store=STORE_LOCATION):
542
"""Save option and its value in the configuration."""
543
assert store in [STORE_LOCATION,
544
STORE_LOCATION_NORECURSE,
545
STORE_LOCATION_APPENDPATH], 'bad storage policy'
546
# FIXME: RBC 20051029 This should refresh the parser and also take a
547
# file lock on locations.conf.
548
conf_dir = os.path.dirname(self._get_filename())
549
ensure_config_dir_exists(conf_dir)
550
location = self.location
551
if location.endswith('/'):
552
location = location[:-1]
553
if (not location in self._get_parser() and
554
not location + '/' in self._get_parser()):
555
self._get_parser()[location]={}
556
elif location + '/' in self._get_parser():
557
location = location + '/'
558
self._get_parser()[location][option]=value
559
# the allowed values of store match the config policies
560
self._set_option_policy(location, option, store)
561
self._get_parser().write(file(self._get_filename(), 'wb'))
250
def _get_user_id(self):
251
user_id = super(LocationConfig, self)._get_user_id()
252
if user_id is not None:
254
return self._get_global_config()._get_user_id()
256
def _get_signature_checking(self):
257
"""See Config._get_signature_checking."""
258
check = super(LocationConfig, self)._get_signature_checking()
259
if check is not None:
261
return self._get_global_config()._get_signature_checking()
564
264
class BranchConfig(Config):
565
265
"""A configuration object giving the policy for a branch."""
567
def _get_branch_data_config(self):
568
if self._branch_data_config is None:
569
self._branch_data_config = TreeConfig(self.branch)
570
return self._branch_data_config
572
267
def _get_location_config(self):
573
268
if self._location_config is None:
574
269
self._location_config = LocationConfig(self.branch.base)
575
270
return self._location_config
577
def _get_global_config(self):
578
if self._global_config is None:
579
self._global_config = GlobalConfig()
580
return self._global_config
582
def _get_best_value(self, option_name):
583
"""This returns a user option from local, tree or global config.
585
They are tried in that order. Use get_safe_value if trusted values
588
for source in self.option_sources:
589
value = getattr(source(), option_name)()
590
if value is not None:
594
def _get_safe_value(self, option_name):
595
"""This variant of get_best_value never returns untrusted values.
597
It does not return values from the branch data, because the branch may
598
not be controlled by the user.
600
We may wish to allow locations.conf to control whether branches are
601
trusted in the future.
603
for source in (self._get_location_config, self._get_global_config):
604
value = getattr(source(), option_name)()
605
if value is not None:
609
272
def _get_user_id(self):
610
273
"""Return the full user id for the branch.
613
276
This is looked up in the email controlfile for the branch.
616
return (self.branch.control_files.get_utf8("email")
279
return (self.branch.controlfile("email", "r")
618
281
.decode(bzrlib.user_encoding)
620
283
except errors.NoSuchFile, e:
623
return self._get_best_value('_get_user_id')
286
return self._get_location_config()._get_user_id()
625
288
def _get_signature_checking(self):
626
289
"""See Config._get_signature_checking."""
627
return self._get_best_value('_get_signature_checking')
629
def _get_signing_policy(self):
630
"""See Config._get_signing_policy."""
631
return self._get_best_value('_get_signing_policy')
633
def _get_user_option(self, option_name):
634
"""See Config._get_user_option."""
635
for source in self.option_sources:
636
value = source()._get_user_option(option_name)
637
if value is not None:
641
def set_user_option(self, name, value, store=STORE_BRANCH):
642
if store == STORE_BRANCH:
643
self._get_branch_data_config().set_option(value, name)
644
elif store == STORE_GLOBAL:
645
self._get_global_config().set_user_option(name, value)
647
self._get_location_config().set_user_option(name, value, store)
649
def _gpg_signing_command(self):
650
"""See Config.gpg_signing_command."""
651
return self._get_safe_value('_gpg_signing_command')
290
return self._get_location_config()._get_signature_checking()
653
292
def __init__(self, branch):
654
293
super(BranchConfig, self).__init__()
655
294
self._location_config = None
656
self._branch_data_config = None
657
self._global_config = None
658
295
self.branch = branch
659
self.option_sources = (self._get_location_config,
660
self._get_branch_data_config,
661
self._get_global_config)
663
def _post_commit(self):
664
"""See Config.post_commit."""
665
return self._get_safe_value('_post_commit')
667
def _get_nickname(self):
668
value = self._get_explicit_nickname()
669
if value is not None:
671
return urlutils.unescape(self.branch.base.split('/')[-2])
673
def has_explicit_nickname(self):
674
"""Return true if a nickname has been explicitly assigned."""
675
return self._get_explicit_nickname() is not None
677
def _get_explicit_nickname(self):
678
return self._get_best_value('_get_nickname')
680
def _log_format(self):
681
"""See Config.log_format."""
682
return self._get_best_value('_log_format')
685
def ensure_config_dir_exists(path=None):
686
"""Make sure a configuration directory exists.
687
This makes sure that the directory exists.
688
On windows, since configuration directories are 2 levels deep,
689
it makes sure both the directory and the parent directory exists.
693
if not os.path.isdir(path):
694
if sys.platform == 'win32':
695
parent_dir = os.path.dirname(path)
696
if not os.path.isdir(parent_dir):
697
mutter('creating config parent directory: %r', parent_dir)
699
mutter('creating config directory: %r', path)
703
298
def config_dir():
708
303
TODO: Global option --config-dir to override this.
710
base = os.environ.get('BZR_HOME', None)
711
if sys.platform == 'win32':
713
base = win32utils.get_appdata_location_unicode()
715
base = os.environ.get('HOME', None)
717
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
718
return osutils.pathjoin(base, 'bazaar', '2.0')
720
# cygwin, linux, and darwin all have a $HOME directory
722
base = os.path.expanduser("~")
723
return osutils.pathjoin(base, ".bazaar")
305
return os.path.join(os.path.expanduser("~"), ".bazaar")
726
308
def config_filename():
727
309
"""Return per-user configuration ini file filename."""
728
return osutils.pathjoin(config_dir(), 'bazaar.conf')
310
return os.path.join(config_dir(), 'bazaar.conf')
731
313
def branches_config_filename():
732
314
"""Return per-user configuration ini file filename."""
733
return osutils.pathjoin(config_dir(), 'branches.conf')
736
def locations_config_filename():
737
"""Return per-user configuration ini file filename."""
738
return osutils.pathjoin(config_dir(), 'locations.conf')
741
def user_ignore_config_filename():
742
"""Return the user default ignore filename"""
743
return osutils.pathjoin(config_dir(), 'ignore')
315
return os.path.join(config_dir(), 'branches.conf')
746
318
def _auto_user_id():
759
if sys.platform == 'win32':
760
name = win32utils.get_user_name_unicode()
762
raise errors.BzrError("Cannot autodetect user name.\n"
763
"Please, set your name with command like:\n"
764
'bzr whoami "Your Name <name@domain.com>"')
765
host = win32utils.get_host_name_unicode()
767
host = socket.gethostname()
768
return name, (name + '@' + host)
331
# XXX: Any good way to get real user name on win32?
772
335
uid = os.getuid()
773
336
w = pwd.getpwuid(uid)
775
# we try utf-8 first, because on many variants (like Linux),
776
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
777
# false positives. (many users will have their user encoding set to
778
# latin-1, which cannot raise UnicodeError.)
780
gecos = w.pw_gecos.decode('utf-8')
784
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
785
encoding = bzrlib.user_encoding
787
raise errors.BzrCommandError('Unable to determine your name. '
788
'Use "bzr whoami" to set it.')
790
username = w.pw_name.decode(encoding)
792
raise errors.BzrCommandError('Unable to determine your name. '
793
'Use "bzr whoami" to set it.')
337
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
338
username = w.pw_name.decode(bzrlib.user_encoding)
795
339
comma = gecos.find(',')
824
364
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
826
raise errors.NoEmailInUsername(e)
366
raise BzrError("%r doesn't seem to contain "
367
"a reasonable email address" % e)
827
368
return m.group(0)
830
class TreeConfig(IniBasedConfig):
831
"""Branch configuration data associated with its contents, not location"""
832
def __init__(self, branch):
835
def _get_parser(self, file=None):
837
return IniBasedConfig._get_parser(file)
838
return self._get_config()
840
def _get_config(self):
842
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
844
except errors.NoSuchFile:
845
obj = ConfigObj(encoding='utf=8')
848
def get_option(self, name, section=None, default=None):
849
self.branch.lock_read()
851
obj = self._get_config()
853
if section is not None:
862
def set_option(self, value, name, section=None):
863
"""Set a per-branch configuration option"""
864
self.branch.lock_write()
866
cfg_obj = self._get_config()
871
obj = cfg_obj[section]
873
cfg_obj[section] = {}
874
obj = cfg_obj[section]
876
out_file = StringIO()
877
cfg_obj.write(out_file)
879
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
